move existing documentation into new standard layout

Change-Id: Iaefc26222d42663423f736946dea97c5613b7d1c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-28 14:01:05 -04:00
parent ded939ba71
commit 88a104d852
13 changed files with 37 additions and 27 deletions

2
.gitignore vendored
View File

@ -9,7 +9,7 @@ cover/
oslo.policy.egg-info/
build/
dist/
doc/source/api
doc/source/reference/api/
AUTHORS
.update-venv/
ChangeLog

View File

@ -2,4 +2,4 @@
Contributing
==============
.. include:: ../../CONTRIBUTING.rst
.. include:: ../../../CONTRIBUTING.rst

View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

View File

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

View File

@ -0,0 +1,8 @@
===========================
oslo.policy API Reference
===========================
.. toctree::
api/autoindex

View File

@ -0,0 +1,5 @@
===========
ChangeLog
===========
.. include:: ../../../ChangeLog

10
doc/source/user/index.rst Normal file
View File

@ -0,0 +1,10 @@
===================
Using oslo.policy
===================
.. toctree::
usage
sphinxpolicygen
history

View File

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