rearrange existing documentation to fit the new standard layout

Change-Id: I0727caae202b385d740b006fd957b990e308c6d7
2017-07-01 20:21:47 +09:00 · 2017-07-01 20:21:47 +09:00 · 0f3ea232b7
parent d14dfdf5c4
commit 0f3ea232b7
26 changed files with 49 additions and 50 deletions
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@ -1,5 +0,0 @@
-==============
- Contributing
-==============
-
-.. include:: ../../CONTRIBUTING.rst
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -0,0 +1,5 @@
+============
+Contributing
+============
+
+.. 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,51 +8,12 @@ such as encoding, exception handling, string manipulation, and time handling.
 .. toctree::
   :maxdepth: 1

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

-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-
-   api/dictutils
-   api/encodeutils
-   api/eventletutils
-   api/excutils
-   api/fileutils
-   api/fixture
-   api/importutils
-   api/netutils
-   api/reflection
-   api/secretutils
-   api/specs_matcher
-   api/strutils
-   api/timeutils
-   api/units
-   api/uuidutils
-   api/versionutils
-
-Examples
-========
-
-.. toctree::
-   :maxdepth: 2
-
-   examples/timeutils
-
-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/dictutils.rst
+++ b/doc/source/reference/dictutils.rst
--- a/doc/source/reference/encodeutils.rst
+++ b/doc/source/reference/encodeutils.rst
--- a/doc/source/reference/eventletutils.rst
+++ b/doc/source/reference/eventletutils.rst
--- a/doc/source/reference/excutils.rst
+++ b/doc/source/reference/excutils.rst
--- a/doc/source/reference/fileutils.rst
+++ b/doc/source/reference/fileutils.rst
--- a/doc/source/reference/fixture.rst
+++ b/doc/source/reference/fixture.rst
--- a/doc/source/reference/importutils.rst
+++ b/doc/source/reference/importutils.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -0,0 +1,23 @@
+=============
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   dictutils
+   encodeutils
+   eventletutils
+   excutils
+   fileutils
+   fixture
+   importutils
+   netutils
+   reflection
+   secretutils
+   specs_matcher
+   strutils
+   timeutils
+   units
+   uuidutils
+   versionutils
--- a/doc/source/reference/netutils.rst
+++ b/doc/source/reference/netutils.rst
--- a/doc/source/reference/reflection.rst
+++ b/doc/source/reference/reflection.rst
--- a/doc/source/reference/secretutils.rst
+++ b/doc/source/reference/secretutils.rst
--- a/doc/source/reference/specs_matcher.rst
+++ b/doc/source/reference/specs_matcher.rst
--- a/doc/source/reference/strutils.rst
+++ b/doc/source/reference/strutils.rst
--- a/doc/source/reference/timeutils.rst
+++ b/doc/source/reference/timeutils.rst
--- a/doc/source/reference/units.rst
+++ b/doc/source/reference/units.rst
--- a/doc/source/reference/uuidutils.rst
+++ b/doc/source/reference/uuidutils.rst
--- a/doc/source/reference/versionutils.rst
+++ b/doc/source/reference/versionutils.rst
--- 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.service
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   timeutils
+
+.. history contains a lot of sections, toctree with maxdepth 1 is used.
+.. toctree::
+   :maxdepth: 1
+
+   history
--- a/doc/source/examples/timeutils.rst
+++ b/doc/source/examples/timeutils.rst
--- a/doc/source/user/usage.rst
+++ b/doc/source/user/usage.rst