From 0b3aee8cc6d5c373bcba74330f0fea8f0e4e4b26 Mon Sep 17 00:00:00 2001 From: Brant Knudson Date: Mon, 21 Sep 2015 15:23:18 -0500 Subject: [PATCH] Autogenerate the module docs 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 --- .gitignore | 1 + doc/source/api/api.rst | 8 -------- doc/source/api/concurrency.rst | 8 -------- doc/source/api/exception.rst | 8 -------- doc/source/api/index.rst | 12 ------------ doc/source/api/options.rst | 8 -------- doc/source/api/sqlalchemy/index.rst | 9 --------- doc/source/api/sqlalchemy/migration.rst | 8 -------- doc/source/api/sqlalchemy/models.rst | 8 -------- doc/source/api/sqlalchemy/provision.rst | 8 -------- doc/source/api/sqlalchemy/session.rst | 8 -------- doc/source/api/sqlalchemy/test_base.rst | 8 -------- doc/source/api/sqlalchemy/test_migrations.rst | 8 -------- doc/source/api/sqlalchemy/utils.rst | 8 -------- doc/source/conf.py | 3 +++ doc/source/index.rst | 6 +++--- setup.cfg | 4 +++- 17 files changed, 10 insertions(+), 113 deletions(-) delete mode 100644 doc/source/api/api.rst delete mode 100644 doc/source/api/concurrency.rst delete mode 100644 doc/source/api/exception.rst delete mode 100644 doc/source/api/index.rst delete mode 100644 doc/source/api/options.rst delete mode 100644 doc/source/api/sqlalchemy/index.rst delete mode 100644 doc/source/api/sqlalchemy/migration.rst delete mode 100644 doc/source/api/sqlalchemy/models.rst delete mode 100644 doc/source/api/sqlalchemy/provision.rst delete mode 100644 doc/source/api/sqlalchemy/session.rst delete mode 100644 doc/source/api/sqlalchemy/test_base.rst delete mode 100644 doc/source/api/sqlalchemy/test_migrations.rst delete mode 100644 doc/source/api/sqlalchemy/utils.rst diff --git a/.gitignore b/.gitignore index a447b467..a24c6443 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ ChangeLog .project .pydevproject oslo.db.egg-info/ +doc/source/api diff --git a/doc/source/api/api.rst b/doc/source/api/api.rst deleted file mode 100644 index d58cbaff..00000000 --- a/doc/source/api/api.rst +++ /dev/null @@ -1,8 +0,0 @@ -============= - oslo_db.api -============= - -.. automodule:: oslo_db.api - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/concurrency.rst b/doc/source/api/concurrency.rst deleted file mode 100644 index d5775e75..00000000 --- a/doc/source/api/concurrency.rst +++ /dev/null @@ -1,8 +0,0 @@ -===================== - oslo_db.concurrency -===================== - -.. automodule:: oslo_db.concurrency - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/exception.rst b/doc/source/api/exception.rst deleted file mode 100644 index 329525bf..00000000 --- a/doc/source/api/exception.rst +++ /dev/null @@ -1,8 +0,0 @@ -=================== - oslo_db.exception -=================== - -.. automodule:: oslo_db.exception - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst deleted file mode 100644 index 124e451f..00000000 --- a/doc/source/api/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -===== - API -===== - -.. toctree:: - :maxdepth: 2 - - api - concurrency - exception - options - sqlalchemy/index diff --git a/doc/source/api/options.rst b/doc/source/api/options.rst deleted file mode 100644 index 4216cda0..00000000 --- a/doc/source/api/options.rst +++ /dev/null @@ -1,8 +0,0 @@ -================= - oslo_db.options -================= - -.. automodule:: oslo_db.options - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/index.rst b/doc/source/api/sqlalchemy/index.rst deleted file mode 100644 index 5e2496e6..00000000 --- a/doc/source/api/sqlalchemy/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -==================== - oslo_db.sqlalchemy -==================== - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/doc/source/api/sqlalchemy/migration.rst b/doc/source/api/sqlalchemy/migration.rst deleted file mode 100644 index 6c7ee469..00000000 --- a/doc/source/api/sqlalchemy/migration.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================== - oslo_db.sqlalchemy.migration -============================== - -.. automodule:: oslo_db.sqlalchemy.migration - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/models.rst b/doc/source/api/sqlalchemy/models.rst deleted file mode 100644 index 5c6f4619..00000000 --- a/doc/source/api/sqlalchemy/models.rst +++ /dev/null @@ -1,8 +0,0 @@ -=========================== - oslo_db.sqlalchemy.models -=========================== - -.. automodule:: oslo_db.sqlalchemy.models - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/provision.rst b/doc/source/api/sqlalchemy/provision.rst deleted file mode 100644 index 0ae5ff1d..00000000 --- a/doc/source/api/sqlalchemy/provision.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================== - oslo_db.sqlalchemy.provision -============================== - -.. automodule:: oslo_db.sqlalchemy.provision - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/session.rst b/doc/source/api/sqlalchemy/session.rst deleted file mode 100644 index b6635bdc..00000000 --- a/doc/source/api/sqlalchemy/session.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================ - oslo_db.sqlalchemy.session -============================ - -.. automodule:: oslo_db.sqlalchemy.session - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/test_base.rst b/doc/source/api/sqlalchemy/test_base.rst deleted file mode 100644 index 0eb6878b..00000000 --- a/doc/source/api/sqlalchemy/test_base.rst +++ /dev/null @@ -1,8 +0,0 @@ -============================== - oslo_db.sqlalchemy.test_base -============================== - -.. automodule:: oslo_db.sqlalchemy.test_base - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/test_migrations.rst b/doc/source/api/sqlalchemy/test_migrations.rst deleted file mode 100644 index afb24ffa..00000000 --- a/doc/source/api/sqlalchemy/test_migrations.rst +++ /dev/null @@ -1,8 +0,0 @@ -==================================== - oslo_db.sqlalchemy.test_migrations -==================================== - -.. automodule:: oslo_db.sqlalchemy.test_migrations - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/api/sqlalchemy/utils.rst b/doc/source/api/sqlalchemy/utils.rst deleted file mode 100644 index e6576364..00000000 --- a/doc/source/api/sqlalchemy/utils.rst +++ /dev/null @@ -1,8 +0,0 @@ -========================== - oslo_db.sqlalchemy.utils -========================== - -.. automodule:: oslo_db.sqlalchemy.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/conf.py b/doc/source/conf.py index aec93525..4c807234 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 2be70ddf..ac6962ed 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,12 +17,12 @@ API Documentation ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - api/index + api/autoindex Indices and tables ------------------- +================== * :ref:`genindex` * :ref:`modindex` diff --git a/setup.cfg b/setup.cfg index abb016b8..649550b1 100644 --- a/setup.cfg +++ b/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.* \ No newline at end of file