Merge "Autogenerate the module docs"

.gitignore

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

doc/source/api/api.rst

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

doc/source/api/concurrency.rst

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

doc/source/api/exception.rst

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

doc/source/api/index.rst

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

doc/source/api/options.rst

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

doc/source/api/sqlalchemy/index.rst

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

doc/source/api/sqlalchemy/migration.rst

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

doc/source/api/sqlalchemy/models.rst

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

doc/source/api/sqlalchemy/provision.rst

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

doc/source/api/sqlalchemy/session.rst

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

doc/source/api/sqlalchemy/test_base.rst

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

doc/source/api/sqlalchemy/test_migrations.rst

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

doc/source/api/sqlalchemy/utils.rst

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

doc/source/conf.py

@@ -58,6 +58,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

doc/source/index.rst

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

setup.cfg

@@ -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.*