rearrange existing documentation to fit the new standard layout

Fixes formatting things related to openstackdocstheme adoption Change-Id: Ia4272bf073d53ae4075a1b6d860898c0a6121145
2017-07-06 20:55:08 +00:00 · 2017-07-06 20:55:08 +00:00 · e1f6499c67
parent ed34d20c38
commit e1f6499c67
7 changed files with 24 additions and 25 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
@ -8,27 +8,12 @@ in transmittable and storable formats, such as JSON and MessagePack.
 .. toctree::
   :maxdepth: 1

-   installation
-   contributing
+   install/index
+   user/index
+   contributor/index
+   reference/index

-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-
-   api
-
-Release Notes
-=============
-
-.. toctree::
-   :maxdepth: 1
-
-   history
-
-Indices and tables
-==================
+.. rubric:: Indices and tables

 * :ref:`genindex`
 * :ref:`modindex`
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -1,6 +1,6 @@
-=================
-API Documentation
-=================
+=============
+API Reference
+=============


 base64
--- 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,14 @@
+========================
+Using oslo.serialization
+========================
+
+.. toctree::
+   :maxdepth: 2
+
+.. Add more contents here
+
+.. history contains a lot of sections, toctree with maxdepth 1 is used.
+.. toctree::
+   :maxdepth: 1
+
+   Release Notes <history>