Merge "Autogenerate the module docs"

This commit is contained in:
Jenkins 2015-09-24 22:05:38 +00:00 committed by Gerrit Code Review
commit 88f3e6b4a8
17 changed files with 10 additions and 113 deletions

1
.gitignore vendored
View File

@ -18,3 +18,4 @@ ChangeLog
.project .project
.pydevproject .pydevproject
oslo.db.egg-info/ oslo.db.egg-info/
doc/source/api

View File

@ -1,8 +0,0 @@
=============
oslo_db.api
=============
.. automodule:: oslo_db.api
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
=====================
oslo_db.concurrency
=====================
.. automodule:: oslo_db.concurrency
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
===================
oslo_db.exception
===================
.. automodule:: oslo_db.exception
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,12 +0,0 @@
=====
API
=====
.. toctree::
:maxdepth: 2
api
concurrency
exception
options
sqlalchemy/index

View File

@ -1,8 +0,0 @@
=================
oslo_db.options
=================
.. automodule:: oslo_db.options
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,9 +0,0 @@
====================
oslo_db.sqlalchemy
====================
.. toctree::
:maxdepth: 1
:glob:
*

View File

@ -1,8 +0,0 @@
==============================
oslo_db.sqlalchemy.migration
==============================
.. automodule:: oslo_db.sqlalchemy.migration
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
===========================
oslo_db.sqlalchemy.models
===========================
.. automodule:: oslo_db.sqlalchemy.models
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
==============================
oslo_db.sqlalchemy.provision
==============================
.. automodule:: oslo_db.sqlalchemy.provision
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
============================
oslo_db.sqlalchemy.session
============================
.. automodule:: oslo_db.sqlalchemy.session
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
==============================
oslo_db.sqlalchemy.test_base
==============================
.. automodule:: oslo_db.sqlalchemy.test_base
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
====================================
oslo_db.sqlalchemy.test_migrations
====================================
.. automodule:: oslo_db.sqlalchemy.test_migrations
:members:
:undoc-members:
:show-inheritance:

View File

@ -1,8 +0,0 @@
==========================
oslo_db.sqlalchemy.utils
==========================
.. automodule:: oslo_db.sqlalchemy.utils
:members:
:undoc-members:
:show-inheritance:

View File

@ -58,6 +58,9 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['oslo_db.']
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with # The theme to use for HTML and HTML Help pages. Major themes that come with

View File

@ -18,12 +18,12 @@ API Documentation
================= =================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
api/index api/autoindex
Indices and tables Indices and tables
------------------ ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`

View File

@ -63,4 +63,6 @@ fixtures =
# NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then # NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then
# want to treat sphinx warnings as errors # want to treat sphinx warnings as errors
# warnerrors = True # warnerrors = True
#autodoc_index_modules = True autodoc_index_modules = True
autodoc_exclude_modules =
oslo_db.tests.*