rearrange existing documentation to fit the new standard layout

For more detail, see the doc migration spec:
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
There is also the recent status of the work posted in the dev ML:
http://lists.openstack.org/pipermail/openstack-dev/2017-July/119221.html

Change-Id: I1e728fc0bc671150d826747010eb980176f0cc13
This commit is contained in:
Akihiro Motoki 2017-07-06 21:18:00 +00:00
parent 01443b8380
commit a1598502bd
11 changed files with 27 additions and 25 deletions

2
.gitignore vendored
View File

@ -50,7 +50,7 @@ ChangeLog
# Editors
*~
.*.swp
/doc/source/api/
/doc/source/reference/api/
# reno build
releasenotes/build

View File

@ -1 +0,0 @@
.. include:: ../../CONTRIBUTING.rst

View File

@ -0,0 +1 @@
.. include:: ../../../CONTRIBUTING.rst

View File

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

View File

@ -8,29 +8,12 @@ and APIs.
.. toctree::
:maxdepth: 2
installation
usage
contributing
install/index
user/index
contributor/index
reference/index
Code Documentation
==================
.. toctree::
:maxdepth: 1
api/autoindex
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`modindex`

View File

@ -0,0 +1,9 @@
=============
API Reference
=============
.. toctree::
:maxdepth: 1
:glob:
api/*

View File

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

View File

@ -0,0 +1,9 @@
=================
Using oslo.vmware
=================
.. toctree::
:maxdepth: 1
usage
history

View File

@ -50,6 +50,7 @@ autodoc_index_modules = 1
autodoc_exclude_modules =
oslo_vmware._i18n
oslo_vmware.tests.*
api_doc_dir = reference/api
[wheel]
universal = 1