diff options
| author | David Stanek <dstanek@dstanek.com> | 2015-07-07 22:21:41 +0000 |
|---|---|---|
| committer | David Stanek <dstanek@dstanek.com> | 2015-07-07 22:23:00 +0000 |
| commit | 59ebc39d269921259b26cdaea2cffc2ccd99b6e8 (patch) | |
| tree | 29245ec407097afafd88aa4dbb992f44cb58d8d6 | |
| parent | 31d674ba4e50742823f6367f41fda0e28a9cc644 (diff) | |
| download | oslo-policy-59ebc39d269921259b26cdaea2cffc2ccd99b6e8.tar.gz | |
Fixes up the API docs and module index
- Automatically generate the API docs
- Makes the index on the modules index page useful
Change-Id: I4eafe2c64a0733f6fb81b20e85cd943355860f9a
| -rw-r--r-- | doc/source/api.rst | 20 | ||||
| -rwxr-xr-x | doc/source/conf.py | 3 | ||||
| -rw-r--r-- | doc/source/index.rst | 2 | ||||
| -rw-r--r-- | setup.cfg | 1 |
4 files changed, 5 insertions, 21 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst deleted file mode 100644 index 3359357..0000000 --- a/doc/source/api.rst +++ /dev/null @@ -1,20 +0,0 @@ -===== - API -===== - -oslo_policy.policy -================== - -.. automodule:: oslo_policy.policy - :members: - -.. autoclass:: oslo_policy.policy.AndCheck -.. autoclass:: oslo_policy.policy.NotCheck -.. autoclass:: oslo_policy.policy.OrCheck -.. autoclass:: oslo_policy.policy.RuleCheck - -oslo_policy.opts -================ - -.. automodule:: oslo_policy.opts - :members: diff --git a/doc/source/conf.py b/doc/source/conf.py index 4906212..caec96c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -50,6 +50,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_policy.'] + # -- 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 68ab879..9fb010c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,7 +9,7 @@ Contents :maxdepth: 2 installation - api + api/modules usage contributing history @@ -25,6 +25,7 @@ packages = [pbr] warnerrors = true +autodoc_tree_index_modules = True [entry_points] oslo.config.opts = |