diff options
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | doc/source/cli/index.rst (renamed from doc/source/cli.rst) | 0 | ||||
-rw-r--r-- | doc/source/configuration/index.rst (renamed from doc/source/opts.rst) | 0 | ||||
-rw-r--r-- | doc/source/contributor/index.rst (renamed from doc/source/contributing.rst) | 2 | ||||
-rw-r--r-- | doc/source/history.rst | 1 | ||||
-rw-r--r-- | doc/source/index.rst | 27 | ||||
-rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
-rw-r--r-- | doc/source/reference/index.rst | 8 | ||||
-rw-r--r-- | doc/source/user/history.rst | 5 | ||||
-rw-r--r-- | doc/source/user/index.rst | 10 | ||||
-rw-r--r-- | doc/source/user/sphinxpolicygen.rst (renamed from doc/source/sphinxpolicygen.rst) | 0 | ||||
-rw-r--r-- | doc/source/user/usage.rst (renamed from doc/source/usage.rst) | 0 | ||||
-rw-r--r-- | setup.cfg | 9 |
13 files changed, 37 insertions, 27 deletions
@@ -9,7 +9,7 @@ cover/ oslo.policy.egg-info/ build/ dist/ -doc/source/api +doc/source/reference/api/ AUTHORS .update-venv/ ChangeLog diff --git a/doc/source/cli.rst b/doc/source/cli/index.rst index fe5612c..fe5612c 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli/index.rst diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst index cf29f0b..cf29f0b 100644 --- a/doc/source/opts.rst +++ b/doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 0ae3ac3..29dce54 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,30 +5,17 @@ An OpenStack library providing support for RBAC policy enforcement across all OpenStack services. -Contents -======== - .. toctree:: :maxdepth: 2 - installation - api/modules - usage - opts - cli - contributing - sphinxpolicygen - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history + install/index + user/index + configuration/index + cli/index + reference/index + contributor/index -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst index 5b495e0..5b495e0 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..a345d32 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +=========================== + oslo.policy API Reference +=========================== + +.. toctree:: + + api/autoindex + diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f8b24fd --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1,5 @@ +=========== + ChangeLog +=========== + +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..cfb053b --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,10 @@ +=================== + Using oslo.policy +=================== + +.. toctree:: + + usage + sphinxpolicygen + history + diff --git a/doc/source/sphinxpolicygen.rst b/doc/source/user/sphinxpolicygen.rst index bf9fc89..bf9fc89 100644 --- a/doc/source/sphinxpolicygen.rst +++ b/doc/source/user/sphinxpolicygen.rst diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst index 93d8ad1..93d8ad1 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst @@ -23,10 +23,11 @@ packages = oslo_policy [pbr] -autodoc_tree_index_modules = True -autodoc_tree_excludes = - setup.py - oslo_policy/tests/ +autodoc_index_modules = True +api_doc_dir = reference/api +autodoc_exclude_modules = + oslo_policy.tests.* + oslo_policy._* [entry_points] oslo.config.opts = |