diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/api/api.rst | 8 | ||||
-rw-r--r-- | doc/source/api/concurrency.rst | 8 | ||||
-rw-r--r-- | doc/source/api/exception.rst | 8 | ||||
-rw-r--r-- | doc/source/api/index.rst | 12 | ||||
-rw-r--r-- | doc/source/api/options.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/index.rst | 9 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/migration.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/models.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/provision.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/session.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/test_base.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/test_migrations.rst | 8 | ||||
-rw-r--r-- | doc/source/api/sqlalchemy/utils.rst | 8 | ||||
-rwxr-xr-x | doc/source/conf.py | 4 | ||||
-rw-r--r-- | doc/source/index.rst | 7 | ||||
-rw-r--r-- | doc/source/opts.rst | 9 |
16 files changed, 17 insertions, 112 deletions
diff --git a/doc/source/api/api.rst b/doc/source/api/api.rst deleted file mode 100644 index d58cbaf..0000000 --- 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 d5775e7..0000000 --- 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 329525b..0000000 --- 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 124e451..0000000 --- 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 4216cda..0000000 --- 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 5e2496e..0000000 --- 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 6c7ee46..0000000 --- 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 5c6f461..0000000 --- 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 0ae5ff1..0000000 --- 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 b6635bd..0000000 --- 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 0eb6878..0000000 --- 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 afb24ff..0000000 --- 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 e657636..0000000 --- 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 aec9352..aa53ed0 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', + 'oslo_config.sphinxext', 'oslosphinx' ] @@ -57,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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 5a03c80..de4d909 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ utils. :maxdepth: 2 installation + opts usage contributing history @@ -18,12 +19,12 @@ API Documentation ================= .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - api/index + api/autoindex Indices and tables ------------------- +================== * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..aa6f145 --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,9 @@ +===================== +Configuration Options +===================== + +oslo.db uses oslo.config to define and manage configuration +options to allow the deployer to control how an application uses the +underlying database. + +.. show-options:: oslo.db |