From 9014fdd8d4851be369ad4f0ced2cb8c26f7f345a Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Fri, 7 Jul 2017 14:26:34 -0400 Subject: [PATCH] rearrange existing documentation to follow the new layout standard Change-Id: I79d7b97c7e9395f75fa158d870485853418a4db7 Signed-off-by: Doug Hellmann --- .../{opts.rst => configuration/index.rst} | 0 doc/source/{ => contributor}/contributing.rst | 2 +- doc/source/contributor/history.rst | 1 + doc/source/contributor/index.rst | 9 +++++++ doc/source/history.rst | 1 - doc/source/index.rst | 25 ++++--------------- .../{installation.rst => install/index.rst} | 0 .../{api => reference}/fixture.lockutils.rst | 0 doc/source/{api => reference}/index.rst | 4 +++ doc/source/{api => reference}/lockutils.rst | 0 doc/source/{api => reference}/opts.rst | 0 .../{api => reference}/processutils.rst | 0 doc/source/{api => reference}/watchdog.rst | 0 doc/source/{usage.rst => user/index.rst} | 2 +- 14 files changed, 21 insertions(+), 23 deletions(-) rename doc/source/{opts.rst => configuration/index.rst} (100%) rename doc/source/{ => contributor}/contributing.rst (53%) create mode 100644 doc/source/contributor/history.rst create mode 100644 doc/source/contributor/index.rst delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{api => reference}/fixture.lockutils.rst (100%) rename doc/source/{api => reference}/index.rst (67%) rename doc/source/{api => reference}/lockutils.rst (100%) rename doc/source/{api => reference}/opts.rst (100%) rename doc/source/{api => reference}/processutils.rst (100%) rename doc/source/{api => reference}/watchdog.rst (100%) rename doc/source/{usage.rst => user/index.rst} (98%) diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst similarity index 100% rename from doc/source/opts.rst rename to doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/history.rst b/doc/source/contributor/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/contributor/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..ae57822 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +===================== + Contributor's Guide +===================== + +.. toctree:: + :maxdepth: 2 + + contributing + history diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 4ff4a70..f2297d1 100644 --- 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 ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/api/fixture.lockutils.rst b/doc/source/reference/fixture.lockutils.rst similarity index 100% rename from doc/source/api/fixture.lockutils.rst rename to doc/source/reference/fixture.lockutils.rst diff --git a/doc/source/api/index.rst b/doc/source/reference/index.rst similarity index 67% rename from doc/source/api/index.rst rename to doc/source/reference/index.rst index 2ee39d8..60abf32 100644 --- a/doc/source/api/index.rst +++ b/doc/source/reference/index.rst @@ -1,3 +1,7 @@ +=============== + API Reference +=============== + .. toctree:: :maxdepth: 1 diff --git a/doc/source/api/lockutils.rst b/doc/source/reference/lockutils.rst similarity index 100% rename from doc/source/api/lockutils.rst rename to doc/source/reference/lockutils.rst diff --git a/doc/source/api/opts.rst b/doc/source/reference/opts.rst similarity index 100% rename from doc/source/api/opts.rst rename to doc/source/reference/opts.rst diff --git a/doc/source/api/processutils.rst b/doc/source/reference/processutils.rst similarity index 100% rename from doc/source/api/processutils.rst rename to doc/source/reference/processutils.rst diff --git a/doc/source/api/watchdog.rst b/doc/source/reference/watchdog.rst similarity index 100% rename from doc/source/api/watchdog.rst rename to doc/source/reference/watchdog.rst diff --git a/doc/source/usage.rst b/doc/source/user/index.rst similarity index 98% rename from doc/source/usage.rst rename to doc/source/user/index.rst index dd8ba98..1867faf 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/index.rst @@ -10,7 +10,7 @@ example:: .. seealso:: - * :doc:`API Documentation ` + * :doc:`API Documentation <../reference/index>` Locking a function (local to a process) =======================================