From e1f6499c6701b49006eaccc36f0854eaf38e6739 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 6 Jul 2017 20:55:08 +0000 Subject: [PATCH] rearrange existing documentation to fit the new standard layout Fixes formatting things related to openstackdocstheme adoption Change-Id: Ia4272bf073d53ae4075a1b6d860898c0a6121145 --- .../index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 25 ++++--------------- .../{installation.rst => install/index.rst} | 0 doc/source/{api.rst => reference/index.rst} | 6 ++--- doc/source/user/history.rst | 1 + doc/source/user/index.rst | 14 +++++++++++ 7 files changed, 24 insertions(+), 25 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (53%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{api.rst => reference/index.rst} (81%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 2ca75d1..ed5290b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. include:: ../../../CONTRIBUTING.rst 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 e459467..afa8612 100644 --- 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` 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.rst b/doc/source/reference/index.rst similarity index 81% rename from doc/source/api.rst rename to doc/source/reference/index.rst index fd662c8..bf19756 100644 --- a/doc/source/api.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -================= -API Documentation -================= +============= +API Reference +============= base64 diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /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 0000000..55d1bdf --- /dev/null +++ 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