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
This commit is contained in:
David Stanek 2015-07-07 22:21:41 +00:00
parent 31d674ba4e
commit 59ebc39d26
4 changed files with 5 additions and 21 deletions

View File

@ -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:

View File

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

View File

@ -9,7 +9,7 @@ Contents
:maxdepth: 2
installation
api
api/modules
usage
contributing
history

View File

@ -25,6 +25,7 @@ packages =
[pbr]
warnerrors = true
autodoc_tree_index_modules = True
[entry_points]
oslo.config.opts =