openstack/oslo.db
Code Issues Proposed changes

Autogenerate the module docs

Browse Source 
The module docs were out of date (sqlalchemy.enginefacade was
missing).

Rather than try to keep this up to date by hand, autogenerate the
module docs.

Change-Id: I9b36cc635c1c0af9a61b5da20205f5628aec97e7
This commit is contained in:
Brant Knudson 2015-09-21 15:23:18 -05:00
parent 7daffffafc
commit 0b3aee8cc6
17 changed files with 10 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

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

8
doc/source/api/api.rst
View File

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

8
doc/source/api/concurrency.rst
View File

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

8
doc/source/api/exception.rst
View File

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

12
doc/source/api/index.rst
View File

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

8
doc/source/api/options.rst
View File

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

9
doc/source/api/sqlalchemy/index.rst
View File

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

8
doc/source/api/sqlalchemy/migration.rst
View File

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

8
doc/source/api/sqlalchemy/models.rst
View File

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

8
doc/source/api/sqlalchemy/provision.rst
View File

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

8
doc/source/api/sqlalchemy/session.rst
View File

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

8
doc/source/api/sqlalchemy/test_base.rst
View File

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

8
doc/source/api/sqlalchemy/test_migrations.rst
View File

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

8
doc/source/api/sqlalchemy/utils.rst
View File

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

3
doc/source/conf.py
View File

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

6
doc/source/index.rst
View File

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

4
setup.cfg
View File

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