From b8377259c50ecf4b4ec669d9c30d5f5d86d58c1b Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Thu, 29 Jun 2017 00:04:45 +0800 Subject: [PATCH] rearrange content to fit the new standard layout Change-Id: Ia24cdc07e81814329108ea841231d8a721726b7e Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 --- .../index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 31 ++++++++++++------- .../{installation.rst => install/index.rst} | 0 doc/source/readme.rst | 1 - doc/source/{ => user}/generate_subunit.rst | 0 doc/source/user/history.rst | 1 + doc/source/{usage.rst => user/index.rst} | 1 + doc/source/{ => user}/ostestr.rst | 0 doc/source/{ => user}/subunit2html.rst | 0 doc/source/{ => user}/subunit_trace.rst | 0 11 files changed, 23 insertions(+), 14 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%) delete mode 100644 doc/source/readme.rst rename doc/source/{ => user}/generate_subunit.rst (100%) create mode 100644 doc/source/user/history.rst rename doc/source/{usage.rst => user/index.rst} (94%) rename doc/source/{ => user}/ostestr.rst (100%) rename doc/source/{ => user}/subunit2html.rst (100%) rename doc/source/{ => user}/subunit_trace.rst (100%) 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 1728a61..2aa0707 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -1,4 +1,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 1ac9d4d..50175ec 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,21 +1,30 @@ -.. os-testr 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 os-testr's documentation! -======================================================== +==================================== + +.. image:: https://img.shields.io/pypi/v/os-testr.svg + :target: https://pypi.python.org/pypi/os-testr/ + :alt: Latest Version + +.. image:: https://img.shields.io/pypi/dm/os-testr.svg + :target: https://pypi.python.org/pypi/os-testr/ + :alt: Downloads + +A testr wrapper to provide functionality for OpenStack projects. + +* Free software: Apache license +* Documentation: http://docs.openstack.org/os-testr/ +* Source: http://git.openstack.org/cgit/openstack/os-testr +* Bugs: http://bugs.launchpad.net/os-testr Contents: .. toctree:: :maxdepth: 2 - readme - installation - usage - contributing - history + install/index + contributor/index + user/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/generate_subunit.rst b/doc/source/user/generate_subunit.rst similarity index 100% rename from doc/source/generate_subunit.rst rename to doc/source/user/generate_subunit.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/usage.rst b/doc/source/user/index.rst similarity index 94% rename from doc/source/usage.rst rename to doc/source/user/index.rst index c7d19bb..76ab5a5 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/index.rst @@ -11,3 +11,4 @@ This section contains the documentation for each of tools packaged in os-testr subunit_trace subunit2html generate_subunit + history diff --git a/doc/source/ostestr.rst b/doc/source/user/ostestr.rst similarity index 100% rename from doc/source/ostestr.rst rename to doc/source/user/ostestr.rst diff --git a/doc/source/subunit2html.rst b/doc/source/user/subunit2html.rst similarity index 100% rename from doc/source/subunit2html.rst rename to doc/source/user/subunit2html.rst diff --git a/doc/source/subunit_trace.rst b/doc/source/user/subunit_trace.rst similarity index 100% rename from doc/source/subunit_trace.rst rename to doc/source/user/subunit_trace.rst