From 61d067b03724ddfce46ac36a3d46fe0a9a4f9564 Mon Sep 17 00:00:00 2001 From: "ChangBo Guo(gcb)" Date: Thu, 13 Jul 2017 11:21:05 +0800 Subject: [PATCH] rearrange content to fit the new standard layout Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: Ic1cf3f4b0510d18961d3d15d7776aeeebb071193 --- .gitignore | 2 +- .../index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 27 +++---------------- .../{installation.rst => install/index.rst} | 0 doc/source/reference/index.rst | 9 +++++++ doc/source/{ => user}/cross-testing.rst | 0 doc/source/{ => user}/debugging.rst | 0 doc/source/{ => user}/features.rst | 0 doc/source/user/history.rst | 1 + doc/source/user/index.rst | 13 +++++++++ doc/source/{ => user}/resources.rst | 0 doc/source/{ => user}/testing.rst | 0 setup.cfg | 3 +++ 14 files changed, 32 insertions(+), 26 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%) create mode 100644 doc/source/reference/index.rst rename doc/source/{ => user}/cross-testing.rst (100%) rename doc/source/{ => user}/debugging.rst (100%) rename doc/source/{ => user}/features.rst (100%) create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/resources.rst (100%) rename doc/source/{ => user}/testing.rst (100%) diff --git a/.gitignore b/.gitignore index bd516df..b32ba58 100644 --- a/.gitignore +++ b/.gitignore @@ -44,7 +44,7 @@ output/*/index.html # Sphinx doc/build -/doc/source/api/ +/doc/source/reference/api/ # pbr generates these AUTHORS 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 9ac5556..8a672a7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,29 +5,10 @@ oslotest -- OpenStack Testing Framework and Utilities .. toctree:: :maxdepth: 2 - installation - testing - features - cross-testing - debugging - resources - contributing - -API -=== - -.. toctree:: - :maxdepth: 1 - - api/autoindex - -Release Notes -============= - -.. toctree:: - :maxdepth: 1 - - history + install/index + contributor/index + user/index + reference/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/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..9646baf --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,9 @@ +.. _using: + +API +=== + +.. toctree:: + :maxdepth: 1 + + api/autoindex \ No newline at end of file diff --git a/doc/source/cross-testing.rst b/doc/source/user/cross-testing.rst similarity index 100% rename from doc/source/cross-testing.rst rename to doc/source/user/cross-testing.rst diff --git a/doc/source/debugging.rst b/doc/source/user/debugging.rst similarity index 100% rename from doc/source/debugging.rst rename to doc/source/user/debugging.rst diff --git a/doc/source/features.rst b/doc/source/user/features.rst similarity index 100% rename from doc/source/features.rst rename to doc/source/user/features.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..719dfb5 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,13 @@ +============== +Using oslotest +============== + +.. toctree:: + :maxdepth: 2 + + features + debugging + testing + cross-testing + resources + history \ No newline at end of file diff --git a/doc/source/resources.rst b/doc/source/user/resources.rst similarity index 100% rename from doc/source/resources.rst rename to doc/source/user/resources.rst diff --git a/doc/source/testing.rst b/doc/source/user/testing.rst similarity index 100% rename from doc/source/testing.rst rename to doc/source/user/testing.rst diff --git a/setup.cfg b/setup.cfg index 7c7ff61..52cc216 100644 --- a/setup.cfg +++ b/setup.cfg @@ -37,6 +37,9 @@ upload-dir = doc/build/html [pbr] autodoc_index_modules = true +api_doc_dir = reference/api +autodoc_exclude_modules = + oslotest.tests.* [wheel] universal = true