From 54b1b52533efa255852f342342b2fdc33b5c3a4e Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Wed, 5 Jul 2017 02:23:31 +0900 Subject: [PATCH] rearrange existing documentation to fit the new standard layout README.rst was updated as the title of the doc top page was wrong. Change-Id: I3821bdaa78a982c0a08fef584aec62a5549d5b8b --- README.rst | 15 ++++++--------- doc/source/contributing.rst | 1 - doc/source/contributor/contributing.rst | 1 + doc/source/contributor/index.rst | 9 +++++++++ doc/source/{ => contributor}/testing.rst | 0 doc/source/index.rst | 14 ++++++-------- .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 1 - doc/source/{usage.rst => user/index.rst} | 0 9 files changed, 22 insertions(+), 19 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst create mode 100644 doc/source/contributor/index.rst rename doc/source/{ => contributor}/testing.rst (100%) rename doc/source/{installation.rst => install/index.rst} (100%) delete mode 100644 doc/source/readme.rst rename doc/source/{usage.rst => user/index.rst} (100%) diff --git a/README.rst b/README.rst index f3aaf5d0..9f6a59b1 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,3 @@ -======================== -Team and repository tags -======================== - -.. image:: https://governance.openstack.org/badges/castellan.svg - :target: https://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - ========= Castellan ========= @@ -17,3 +8,9 @@ Generic Key Manager interface for OpenStack. * Documentation: https://docs.openstack.org/developer/castellan * Source: https://git.openstack.org/cgit/openstack/castellan * Bugs: https://bugs.launchpad.net/castellan + +Team and repository tags +======================== + +.. image:: https://governance.openstack.org/badges/castellan.svg + :target: https://governance.openstack.org/reference/tags/index.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 8cb3146f..00000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..b1cd2f37 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..d44152a5 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,9 @@ +==================== +Contributor Document +==================== + +.. toctree:: + :maxdepth: 2 + + contributing + testing diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index dc7e4397..7b9de8ed 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,19 +3,17 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to castellan's documentation! -======================================================== +.. include:: ../../README.rst -Contents: +Contents +======== .. toctree:: :maxdepth: 2 - readme - installation - usage - testing - contributing + install/index + user/index + contributor/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/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/user/index.rst similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/index.rst