rearrange content to fit the new standard layout

Change-Id: I5cbe836cf54f752eb4f93e105ffb49b387440db7
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
This commit is contained in:
Dong Ma 2017-07-06 23:43:58 +08:00
parent 6041068f77
commit a2335dbb69
11 changed files with 32 additions and 9 deletions

2
.gitignore vendored
View File

@ -41,7 +41,7 @@ output/*/index.html
# Sphinx # Sphinx
doc/build doc/build
doc/source/api doc/source/reference/api
# pbr generates these # pbr generates these
AUTHORS AUTHORS

View File

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

View File

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

View File

@ -10,12 +10,11 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
installation install/index
api/modules contributor/index
usage configuration/index
opts user/index
contributing reference/index
history
Indices and tables Indices and tables
================== ==================

View File

@ -0,0 +1,10 @@
.. _using:
=========
Reference
=========
.. toctree::
:maxdepth: 2
api/modules

View File

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

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

@ -0,0 +1,13 @@
================
Using oslo.cache
================
.. toctree::
:maxdepth: 2
usage
.. toctree::
:maxdepth: 1
history

View File

@ -43,6 +43,7 @@ etcd3gw =
[pbr] [pbr]
warnerrors = true warnerrors = true
autodoc_tree_index_modules = True autodoc_tree_index_modules = True
api_doc_dir = reference/api
[build_sphinx] [build_sphinx]
source-dir = doc/source source-dir = doc/source