Enable codebase documenation
Change adds building the codebase documentation that will be part of contributors user guide. Change-Id: I24df404289c8d843d413e094af56b933eb2e22e7
This commit is contained in:
parent
7258d0b23f
commit
0acaeba534
|
@ -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'
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
# codebase documentation is autogenerated
|
||||
# so we do not want to track it in the tree
|
||||
api/
|
|
@ -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
|
|
@ -26,11 +26,12 @@ Developer reference
|
|||
:maxdepth: 1
|
||||
|
||||
tox
|
||||
code
|
||||
|
||||
Changelog
|
||||
---------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 1
|
||||
|
||||
history
|
||||
history
|
||||
|
|
18
setup.cfg
18
setup.cfg
|
@ -70,11 +70,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
|
||||
|
|
Loading…
Reference in New Issue