Documentation fix

Documentation did not match code.
This commit fixes that problem.

Change-Id: I82e2a33080273792dbb3bfed3c85b583b7d658bc
This commit is contained in:
Tomasz Trębski 2016-04-05 09:39:17 +02:00
parent 6f9761fd26
commit fb6e057ced
8 changed files with 49 additions and 85 deletions

View File

@ -63,9 +63,9 @@ author = u'Tomasz Trębski <tomasz.trebski@ts.fujitsu.com>,Lukasz Zajaczkowski <
# built documents.
#
# The short X.Y version.
version = '0.0.1'
version = '0.0.3'
# The full version, including alpha/beta/rc tags.
release = '0.0.1'
release = 'stable/mitaka'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

View File

@ -28,14 +28,6 @@ monasca_log_api.api.logs_api module
:undoc-members:
:show-inheritance:
monasca_log_api.api.rest_utils module
-------------------------------------
.. automodule:: monasca_log_api.api.rest_utils
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.api.versions_api module
---------------------------------------
@ -43,12 +35,3 @@ monasca_log_api.api.versions_api module
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: monasca_log_api.api
:members:
:undoc-members:
:show-inheritance:

View File

@ -7,24 +7,23 @@ Submodules
monasca_log_api.v2.common.log_publisher module
----------------------------------------------
.. automodule:: monasca_log_api.v2.common.log_publisher
.. automodule:: monasca_log_api.reference.common.log_publisher
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.v2.common.service module
----------------------------------------
monasca_log_api.v2.common.model module
--------------------------------------
.. automodule:: monasca_log_api.v2.common.service
.. automodule:: monasca_log_api.reference.common.model
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.v2.common.validation module
-------------------------------------------
Module contents
---------------
.. automodule:: monasca_log_api.v2.common
.. automodule:: monasca_log_api.reference.common.validation
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,18 @@
monasca_log_api.reference.v2 package
====================================
monasca_log_api.reference.v2 module
-----------------------------------
.. automodule:: monasca_log_api.reference.v2.logs
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.reference.v2 module
-----------------------------------
.. automodule:: monasca_log_api.reference.v2.common.service
:members:
:undoc-members:
:show-inheritance:

View File

@ -0,0 +1,19 @@
monasca_log_api.reference.v3 package
====================================
monasca_log_api.reference.v3 module
-----------------------------------
.. automodule:: monasca_log_api.reference.v3.logs
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.reference.v3 module
-----------------------------------
.. automodule:: monasca_log_api.reference.v3.common.helpers
:members:
:undoc-members:
:show-inheritance:

View File

@ -7,7 +7,9 @@ Subpackages
.. toctree::
monasca_log_api.api
monasca_log_api.v2
monasca_log_api.reference.v2
monasca_log_api.reference.v3
monasca_log_api.reference.common
monasca_log_api.middleware
monasca_log_api.healthcheck
@ -21,12 +23,3 @@ monasca_log_api.server module
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: monasca_log_api
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,30 +0,0 @@
monasca_log_api.v2.reference package
====================================
Submodules
----------
monasca_log_api.v2.reference.logs module
----------------------------------------
.. automodule:: monasca_log_api.v2.reference.logs
:members:
:undoc-members:
:show-inheritance:
monasca_log_api.v2.reference.versions module
--------------------------------------------
.. automodule:: monasca_log_api.v2.reference.versions
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: monasca_log_api.v2.reference
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,18 +0,0 @@
monasca_log_api.v2 package
==========================
Subpackages
-----------
.. toctree::
monasca_log_api.v2.common
monasca_log_api.v2.reference
Module contents
---------------
.. automodule:: monasca_log_api.v2
:members:
:undoc-members:
:show-inheritance: