rearrange the documentation to fit into the new standard layout

Change-Id: If9bd83a0ac47084e025899cee681feef06265406
2017-07-05 01:54:52 +09:00 · 2017-07-05 01:54:52 +09:00 · cdb50bed6e
commit cdb50bed6e
parent 3ce185402e
14 changed files with 24 additions and 11 deletions
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -2,4 +2,4 @@
 Contributing
 ==============

-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
--- a/doc/source/history.rst
+++ b/doc/source/history.rst
@ -1 +0,0 @@
-.. include:: ../../ChangeLog
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -5,11 +5,9 @@ Contents:
 .. toctree::
   :maxdepth: 2

-   installation
-   usage
-   examples
-   contributing
-   history
+   install/index
+   user/index
+   contributor/index

 Code Documentation
 ==================
@ -17,7 +15,7 @@ Code Documentation
 .. toctree::
   :maxdepth: 1

-   api/index
+   reference/index

 Indices and tables
 ==================
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/context.rst
+++ b/doc/source/reference/context.rst
--- a/doc/source/reference/fixture.rst
+++ b/doc/source/reference/fixture.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -1,6 +1,6 @@
-==================
- oslo.context API
-==================
+=============
+API reference
+=============

 .. toctree::
   :maxdepth: 1
--- a/doc/source/user/examples.rst
+++ b/doc/source/user/examples.rst
--- a/doc/source/user/examples/usage.py
+++ b/doc/source/user/examples/usage.py
--- a/doc/source/user/examples/usage_simple.py
+++ b/doc/source/user/examples/usage_simple.py
--- a/doc/source/user/examples/usage_user_identity.py
+++ b/doc/source/user/examples/usage_user_identity.py
--- a/doc/source/user/history.rst
+++ b/doc/source/user/history.rst
@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@ -0,0 +1,15 @@
+==================
+Using oslo.context
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   examples
+
+.. history contains a lot of sections, toctree with maxdepth 1 is used.
+.. toctree::
+   :maxdepth: 1
+
+   history
--- a/doc/source/user/usage.rst
+++ b/doc/source/user/usage.rst