From 0f3ea232b750deff33a6106c37a169891872ee93 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 1 Jul 2017 20:21:47 +0900 Subject: [PATCH] rearrange existing documentation to fit the new standard layout Change-Id: I0727caae202b385d740b006fd957b990e308c6d7 --- doc/source/contributing.rst | 5 -- doc/source/contributor/index.rst | 5 ++ doc/source/history.rst | 1 - doc/source/index.rst | 49 ++----------------- .../{installation.rst => install/index.rst} | 0 doc/source/{api => reference}/dictutils.rst | 0 doc/source/{api => reference}/encodeutils.rst | 0 .../{api => reference}/eventletutils.rst | 0 doc/source/{api => reference}/excutils.rst | 0 doc/source/{api => reference}/fileutils.rst | 0 doc/source/{api => reference}/fixture.rst | 0 doc/source/{api => reference}/importutils.rst | 0 doc/source/reference/index.rst | 23 +++++++++ doc/source/{api => reference}/netutils.rst | 0 doc/source/{api => reference}/reflection.rst | 0 doc/source/{api => reference}/secretutils.rst | 0 .../{api => reference}/specs_matcher.rst | 0 doc/source/{api => reference}/strutils.rst | 0 doc/source/{api => reference}/timeutils.rst | 0 doc/source/{api => reference}/units.rst | 0 doc/source/{api => reference}/uuidutils.rst | 0 .../{api => reference}/versionutils.rst | 0 doc/source/user/history.rst | 1 + doc/source/user/index.rst | 15 ++++++ doc/source/{examples => user}/timeutils.rst | 0 doc/source/{ => user}/usage.rst | 0 26 files changed, 49 insertions(+), 50 deletions(-) delete mode 100644 doc/source/contributing.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}/dictutils.rst (100%) rename doc/source/{api => reference}/encodeutils.rst (100%) rename doc/source/{api => reference}/eventletutils.rst (100%) rename doc/source/{api => reference}/excutils.rst (100%) rename doc/source/{api => reference}/fileutils.rst (100%) rename doc/source/{api => reference}/fixture.rst (100%) rename doc/source/{api => reference}/importutils.rst (100%) create mode 100644 doc/source/reference/index.rst rename doc/source/{api => reference}/netutils.rst (100%) rename doc/source/{api => reference}/reflection.rst (100%) rename doc/source/{api => reference}/secretutils.rst (100%) rename doc/source/{api => reference}/specs_matcher.rst (100%) rename doc/source/{api => reference}/strutils.rst (100%) rename doc/source/{api => reference}/timeutils.rst (100%) rename doc/source/{api => reference}/units.rst (100%) rename doc/source/{api => reference}/uuidutils.rst (100%) rename doc/source/{api => reference}/versionutils.rst (100%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{examples => user}/timeutils.rst (100%) rename doc/source/{ => user}/usage.rst (100%) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 2ca75d1b..00000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -============== - Contributing -============== - -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..3d4ceb40 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe6..00000000 --- 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 9b445c46..9cd2faf6 100644 --- 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` 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/dictutils.rst b/doc/source/reference/dictutils.rst similarity index 100% rename from doc/source/api/dictutils.rst rename to doc/source/reference/dictutils.rst diff --git a/doc/source/api/encodeutils.rst b/doc/source/reference/encodeutils.rst similarity index 100% rename from doc/source/api/encodeutils.rst rename to doc/source/reference/encodeutils.rst diff --git a/doc/source/api/eventletutils.rst b/doc/source/reference/eventletutils.rst similarity index 100% rename from doc/source/api/eventletutils.rst rename to doc/source/reference/eventletutils.rst diff --git a/doc/source/api/excutils.rst b/doc/source/reference/excutils.rst similarity index 100% rename from doc/source/api/excutils.rst rename to doc/source/reference/excutils.rst diff --git a/doc/source/api/fileutils.rst b/doc/source/reference/fileutils.rst similarity index 100% rename from doc/source/api/fileutils.rst rename to doc/source/reference/fileutils.rst diff --git a/doc/source/api/fixture.rst b/doc/source/reference/fixture.rst similarity index 100% rename from doc/source/api/fixture.rst rename to doc/source/reference/fixture.rst diff --git a/doc/source/api/importutils.rst b/doc/source/reference/importutils.rst similarity index 100% rename from doc/source/api/importutils.rst rename to doc/source/reference/importutils.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..1fcbb1e0 --- /dev/null +++ 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 diff --git a/doc/source/api/netutils.rst b/doc/source/reference/netutils.rst similarity index 100% rename from doc/source/api/netutils.rst rename to doc/source/reference/netutils.rst diff --git a/doc/source/api/reflection.rst b/doc/source/reference/reflection.rst similarity index 100% rename from doc/source/api/reflection.rst rename to doc/source/reference/reflection.rst diff --git a/doc/source/api/secretutils.rst b/doc/source/reference/secretutils.rst similarity index 100% rename from doc/source/api/secretutils.rst rename to doc/source/reference/secretutils.rst diff --git a/doc/source/api/specs_matcher.rst b/doc/source/reference/specs_matcher.rst similarity index 100% rename from doc/source/api/specs_matcher.rst rename to doc/source/reference/specs_matcher.rst diff --git a/doc/source/api/strutils.rst b/doc/source/reference/strutils.rst similarity index 100% rename from doc/source/api/strutils.rst rename to doc/source/reference/strutils.rst diff --git a/doc/source/api/timeutils.rst b/doc/source/reference/timeutils.rst similarity index 100% rename from doc/source/api/timeutils.rst rename to doc/source/reference/timeutils.rst diff --git a/doc/source/api/units.rst b/doc/source/reference/units.rst similarity index 100% rename from doc/source/api/units.rst rename to doc/source/reference/units.rst diff --git a/doc/source/api/uuidutils.rst b/doc/source/reference/uuidutils.rst similarity index 100% rename from doc/source/api/uuidutils.rst rename to doc/source/reference/uuidutils.rst diff --git a/doc/source/api/versionutils.rst b/doc/source/reference/versionutils.rst similarity index 100% rename from doc/source/api/versionutils.rst rename to doc/source/reference/versionutils.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 00000000..f69be70b --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 00000000..c31b8e42 --- /dev/null +++ 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 diff --git a/doc/source/examples/timeutils.rst b/doc/source/user/timeutils.rst similarity index 100% rename from doc/source/examples/timeutils.rst rename to doc/source/user/timeutils.rst diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst