From 88a104d8522e72c4f0a3defad8e3b7e2e9d6dd32 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 28 Jun 2017 14:01:05 -0400 Subject: [PATCH] move existing documentation into new standard layout Change-Id: Iaefc26222d42663423f736946dea97c5613b7d1c Signed-off-by: Doug Hellmann --- .gitignore | 2 +- doc/source/{cli.rst => cli/index.rst} | 0 .../{opts.rst => configuration/index.rst} | 0 .../index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 27 +++++-------------- .../{installation.rst => install/index.rst} | 0 doc/source/reference/index.rst | 8 ++++++ doc/source/user/history.rst | 5 ++++ doc/source/user/index.rst | 10 +++++++ doc/source/{ => user}/sphinxpolicygen.rst | 0 doc/source/{ => user}/usage.rst | 0 setup.cfg | 9 ++++--- 13 files changed, 37 insertions(+), 27 deletions(-) rename doc/source/{cli.rst => cli/index.rst} (100%) rename doc/source/{opts.rst => configuration/index.rst} (100%) rename doc/source/{contributing.rst => contributor/index.rst} (53%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/reference/index.rst create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/sphinxpolicygen.rst (100%) rename doc/source/{ => user}/usage.rst (100%) diff --git a/.gitignore b/.gitignore index e93e1775..e1c21d0b 100644 --- a/.gitignore +++ b/.gitignore @@ -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 similarity index 100% rename from doc/source/cli.rst rename to doc/source/cli/index.rst diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst similarity index 100% rename from doc/source/opts.rst rename to doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 2ca75d1b..ed5290bb 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 69ed4fe6..00000000 --- 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 0ae3ac38..29dce540 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 + install/index + user/index + configuration/index + cli/index + reference/index + contributor/index -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history - -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..a345d32a --- /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 00000000..f8b24fd0 --- /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 00000000..cfb053b4 --- /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 similarity index 100% rename from doc/source/sphinxpolicygen.rst rename to doc/source/user/sphinxpolicygen.rst diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst diff --git a/setup.cfg b/setup.cfg index cfa04766..15d27c51 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 =