diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst (renamed from doc/source/contributing.rst) | 2 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 27 | ||||
| -rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/user/cross-testing.rst (renamed from doc/source/cross-testing.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/debugging.rst (renamed from doc/source/debugging.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/features.rst (renamed from doc/source/features.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 13 | ||||
| -rw-r--r-- | doc/source/user/resources.rst (renamed from doc/source/resources.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/testing.rst (renamed from doc/source/testing.rst) | 0 | ||||
| -rw-r--r-- | setup.cfg | 3 |
14 files changed, 32 insertions, 26 deletions
@@ -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 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 index 7e0ab67..7e0ab67 100644 --- a/doc/source/installation.rst +++ b/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 index 60a85c3..60a85c3 100644 --- a/doc/source/cross-testing.rst +++ b/doc/source/user/cross-testing.rst diff --git a/doc/source/debugging.rst b/doc/source/user/debugging.rst index 0ddc942..0ddc942 100644 --- a/doc/source/debugging.rst +++ b/doc/source/user/debugging.rst diff --git a/doc/source/features.rst b/doc/source/user/features.rst index feec723..feec723 100644 --- a/doc/source/features.rst +++ b/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 index a8f657f..a8f657f 100644 --- a/doc/source/resources.rst +++ b/doc/source/user/resources.rst diff --git a/doc/source/testing.rst b/doc/source/user/testing.rst index 4ad698a..4ad698a 100644 --- a/doc/source/testing.rst +++ b/doc/source/user/testing.rst @@ -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 |