diff --git a/doc/source/api.rst b/doc/source/api.rst deleted file mode 100644 index 33593579..00000000 --- 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 4906212d..caec96c7 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 68ab879e..9fb010c6 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 diff --git a/setup.cfg b/setup.cfg index b1680f7f..eefc2baa 100644 --- a/setup.cfg +++ b/setup.cfg @@ -25,6 +25,7 @@ packages = [pbr] warnerrors = true +autodoc_tree_index_modules = True [entry_points] oslo.config.opts =