From 9d3fbc726fb4bb5699bb6eec2dfeb51cc0e762f0 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Sat, 1 Jul 2017 18:49:30 +0900 Subject: [PATCH] rearrange existing documentation to fit the new standard layout Change-Id: Iac95a337ac0a3ae8da1dd7c0a575c4d7b68fe632 --- CONTRIBUTING.rst | 9 +++----- .../index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 23 +++++-------------- .../{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 +++++++++++ doc/source/{examples.rst => user/usage.rst} | 0 releasenotes/source/index.rst | 8 +++---- 10 files changed, 32 insertions(+), 32 deletions(-) rename doc/source/{contributing.rst => contributor/index.rst} (50%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{api.rst => reference/index.rst} (93%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{examples.rst => user/usage.rst} (100%) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5ad6f33..6f487a6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,13 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - - http://docs.openstack.org/infra/manual/developers.html +http://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - - http://docs.openstack.org/infra/manual/developers.html#development-workflow +http://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: - - https://bugs.launchpad.net/debtcollector \ No newline at end of file +https://bugs.launchpad.net/debtcollector diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 1f5ca23..3d4ceb4 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 ded7367..8c59d76 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,3 +1,4 @@ +========================================= Welcome to debtcollector's documentation! ========================================= @@ -11,27 +12,15 @@ collect your technical debt in a non-destructive manner. integration is it aims to be generally usable and useful in any project. -Contents -======== - .. toctree:: :maxdepth: 2 - installation - api - examples - contributing + install/index + user/index + reference/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/api.rst b/doc/source/reference/index.rst similarity index 93% rename from doc/source/api.rst rename to doc/source/reference/index.rst index 10761a9..67737c2 100644 --- a/doc/source/api.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -=== -API -=== +============= +API Reference +============= The currently documented publicly exposed API's for usage in your project 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..8af3215 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,14 @@ +=================== +Using debtcollector +=================== + +.. toctree:: + :maxdepth: 2 + + usage + +.. history contains a lot of sections, toctree with maxdepth 1 is used. +.. toctree:: + :maxdepth: 1 + + history diff --git a/doc/source/examples.rst b/doc/source/user/usage.rst similarity index 100% rename from doc/source/examples.rst rename to doc/source/user/usage.rst diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst index 6c4ac3d..17c4663 100644 --- a/releasenotes/source/index.rst +++ b/releasenotes/source/index.rst @@ -2,8 +2,8 @@ debtcollector Release Notes ============================= - .. toctree:: - :maxdepth: 1 +.. toctree:: + :maxdepth: 1 - unreleased - ocata + unreleased + ocata