rearrange content to fit the new standard layout

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: Ic1cf3f4b0510d18961d3d15d7776aeeebb071193
2017-07-13 11:21:05 +08:00
parent 08bdc31572
commit 61d067b037
14 changed files with 32 additions and 26 deletions
--- 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
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@@ -2,4 +2,4 @@
 Contributing
 ============

-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
--- a/doc/source/history.rst
+++ b/doc/source/history.rst
@@ -1 +0,0 @@
-.. include:: ../../ChangeLog
--- 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
 ==================
--- a/doc/source/install/index.rst
+++ b/doc/source/install/index.rst
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,9 @@
+.. _using:
+
+API
+===
+
+.. toctree::
+   :maxdepth: 1
+
+   api/autoindex
--- a/doc/source/user/cross-testing.rst
+++ b/doc/source/user/cross-testing.rst
--- a/doc/source/user/debugging.rst
+++ b/doc/source/user/debugging.rst
--- a/doc/source/user/features.rst
+++ b/doc/source/user/features.rst
--- a/doc/source/user/history.rst
+++ b/doc/source/user/history.rst
@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
--- a/doc/source/user/index.rst
+++ b/doc/source/user/index.rst
@@ -0,0 +1,13 @@
+==============
+Using oslotest
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   features
+   debugging
+   testing
+   cross-testing
+   resources
+   history
--- a/doc/source/user/resources.rst
+++ b/doc/source/user/resources.rst
--- a/doc/source/user/testing.rst
+++ b/doc/source/user/testing.rst
--- 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