Merge "Enable codebase documenation"

This commit is contained in:
Jenkins 2017-07-04 08:01:59 +00:00 committed by Gerrit Code Review
commit 41a02fd88e
6 changed files with 36 additions and 12 deletions

View File

@ -34,8 +34,7 @@ extensions = [
'sphinx.ext.coverage',
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
# 'sphinx.ext.autodoc' causes gate failures, enable as soon as sorted out
# TODO(trebskit)
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
# TODO(trebskit) enable as soon as we get configgen in place
# 'oslo_config.sphinxconfiggen'

3
doc/source/contributor/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
# codebase documentation is autogenerated
# so we do not want to track it in the tree
api/

View File

@ -0,0 +1,18 @@
.. _codedocs:
======================
Codebase documentation
======================
Following section contains codebase documenation generated with, a little
bit of assistance, `sphinx.ext.autodoc`_.
.. _`sphinx.ext.autodoc`: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
Modules
=======
.. toctree::
:maxdepth: 2
api/autoindex.rst

View File

@ -26,11 +26,12 @@ Developer reference
:maxdepth: 1
tox
code
Changelog
---------
.. toctree::
:maxdepth: 1
:maxdepth: 1
history
history

View File

@ -72,11 +72,13 @@ tag_svn_revision = 0
[wheel]
universal = 1
# NOTE(trebskit) autodoc is failling in gate for now
# enable that as soon as bug is sorted out
# [pbr]
# autodoc_index_modules = True
# autodoc_exclude_modules =
# monasca_log_api.tests.*
# monasca_log_api_tempest.*
# api_doc_dir = contributor/api
[pbr]
autodoc_index_modules = True
autodoc_exclude_modules =
monasca_log_api.app.wsgi*
# NOTE(trebskit) we cannot document that because of side-effect
# of trying to load entire application and inability to find
# config files.
monasca_log_api.tests.*
monasca_log_api_tempest.*
api_doc_dir = contributor/api

View File

@ -113,6 +113,7 @@ commands =
description = Builds developer documentation
commands =
rm -rf doc/build
rm -rf doc/source/contributor/api
{[testenv:checkjson]commands}
python setup.py build_sphinx