From eb7ef1567da29969ded383f522b27389ad9be11a Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 8 Jul 2017 21:58:58 +0000 Subject: [PATCH] rearrange existing documentation to fit the new standard layout Change-Id: Ieded73a772471f6b2a32b489b4e3fc33a3daf33e --- .../{contributing.rst => contributor/index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 17 ++++------------- .../{installation.rst => install/index.rst} | 0 doc/source/user/history.rst | 1 + doc/source/user/index.rst | 9 +++++++++ doc/source/{ => user}/usage.rst | 0 7 files changed, 15 insertions(+), 15 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (51%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/usage.rst (100%) diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 51% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 72b4bb2..1022b5a 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 4897568..1a6218a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,20 +8,11 @@ as `root` from OpenStack services. .. toctree:: :maxdepth: 2 - installation - usage - contributing + install/index + user/index + contributor/index -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/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..c20e665 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +=================== +Using oslo.rootwrap +=================== + +.. toctree:: + :maxdepth: 2 + + usage + history 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