From 7b5bb67733ef2b0426c2b52ad3651b63d0e50187 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 2 Jul 2017 19:21:57 +0200 Subject: [PATCH] rearrange existing docs to fit the new standard layout Refer to https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html for details. Change-Id: I10a07ae0b419730960d7d1013ace259dab7a2455 --- doc/source/contributing.rst | 4 ---- doc/source/contributor/index.rst | 5 +++++ doc/source/index.rst | 16 +++++++--------- .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 1 - doc/source/{usage.rst => user/index.rst} | 0 6 files changed, 12 insertions(+), 14 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/index.rst 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/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +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 0000000..3d4ceb4 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 0018bb3..daef110 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,20 +1,18 @@ -.. python-cloudkittyclient documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - +======================================================== Welcome to python-cloudkittyclient's documentation! ======================================================== +This is a client library for CloudKitty built on the CloudKitty API. It +provides a Python API (the ``cloudkittyclient`` module). + Contents: .. toctree:: :maxdepth: 2 - readme - installation - usage - 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 a6210d3..0000000 --- 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