rearrange existing documentation to follow the new layout standard

Change-Id: I79d7b97c7e9395f75fa158d870485853418a4db7 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-07 14:26:34 -04:00 · 2017-07-07 14:26:34 -04:00 · 9014fdd8d4
parent 9d6ba40bd5
commit 9014fdd8d4
14 changed files with 21 additions and 23 deletions
--- a/doc/source/configuration/index.rst
+++ b/doc/source/configuration/index.rst
--- a/doc/source/contributor/contributing.rst
+++ b/doc/source/contributor/contributing.rst
@ -2,4 +2,4 @@
 Contributing
 ==============

-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
--- a/doc/source/contributor/history.rst
+++ b/doc/source/contributor/history.rst
@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@ -0,0 +1,9 @@
+=====================
+ Contributor's Guide
+=====================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributing
+   history
--- 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
@ -9,26 +9,11 @@ external processes.
 .. toctree::
   :maxdepth: 1

-   installation
-   usage
-   opts
-   contributing
-
-API Documentation
-=================
-
-.. toctree::
-   :maxdepth: 1
-
-   api/index
-
-Release Notes
-=============
-
-.. toctree::
-   :maxdepth: 1
-
-   history
+   install/index
+   user/index
+   configuration/index
+   contributor/index
+   reference/index

 Indices and tables
 ==================
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/fixture.lockutils.rst
+++ b/doc/source/reference/fixture.lockutils.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@ -1,3 +1,7 @@
+===============
+ API Reference
+===============
+
 .. toctree::
   :maxdepth: 1

--- a/doc/source/reference/lockutils.rst
+++ b/doc/source/reference/lockutils.rst
--- a/doc/source/reference/opts.rst
+++ b/doc/source/reference/opts.rst
--- a/doc/source/reference/processutils.rst
+++ b/doc/source/reference/processutils.rst
--- a/doc/source/reference/watchdog.rst
+++ b/doc/source/reference/watchdog.rst
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@ -10,7 +10,7 @@ example::

 .. seealso::

-   * :doc:`API Documentation <api/index>`
+   * :doc:`API Documentation <../reference/index>`

 Locking a function (local to a process)
 =======================================