diff options
| author | Andreas Jaeger <aj@suse.com> | 2017-06-30 20:05:14 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-30 20:05:14 +0200 |
| commit | 9af9169b74df0714715c9c1ee41d43a44f71d83d (patch) | |
| tree | 472d660230fc1013e60b920b974ce424dfd0afe9 | |
| parent | 439ee25dc6c998e5571022ce0094a10c2611d717 (diff) | |
| download | python-barbicanclient-9af9169b74df0714715c9c1ee41d43a44f71d83d.tar.gz | |
rearrange the existing docs into the new standard layout
Change-Id: Ic8e3479b46e893bb5351cad59ade1115a007afd8
| -rw-r--r-- | doc/source/cli/authentication.rst (renamed from doc/source/authentication.rst) | 0 | ||||
| -rw-r--r-- | doc/source/cli/cli_usage.rst (renamed from doc/source/cli_usage.rst) | 0 | ||||
| -rw-r--r-- | doc/source/cli/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/cli/usage.rst (renamed from doc/source/usage.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 4 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 5 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 10 | ||||
| -rw-r--r-- | doc/source/contributor/testing.rst (renamed from doc/source/testing.rst) | 0 | ||||
| -rw-r--r-- | doc/source/index.rst | 20 | ||||
| -rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst (renamed from doc/source/reference.rst) | 0 |
11 files changed, 31 insertions, 18 deletions
diff --git a/doc/source/authentication.rst b/doc/source/cli/authentication.rst index cb2dbea..cb2dbea 100644 --- a/doc/source/authentication.rst +++ b/doc/source/cli/authentication.rst diff --git a/doc/source/cli_usage.rst b/doc/source/cli/cli_usage.rst index 78eed1b..78eed1b 100644 --- a/doc/source/cli_usage.rst +++ b/doc/source/cli/cli_usage.rst diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 0000000..0aef2c8 --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,10 @@ +================== +User Documentation +================== + +.. toctree:: + :maxdepth: 2 + + cli_usage + authentication + usage diff --git a/doc/source/usage.rst b/doc/source/cli/usage.rst index c95cdb9..c95cdb9 100644 --- a/doc/source/usage.rst +++ b/doc/source/cli/usage.rst diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ed77c12..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..3d4ceb4 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..98ec114 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,10 @@ +========================= +Contributor Documentation +========================= + +.. toctree:: + :maxdepth: 2 + + contributing.rst + testing.rst + diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst index e94ce75..e94ce75 100644 --- a/doc/source/testing.rst +++ b/doc/source/contributor/testing.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index d61f363..6e5b043 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,3 @@ -.. python-barbicanclient 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. - Python bindings to the OpenStack Key Management API (Barbican) ============================================================== @@ -15,16 +10,13 @@ Contents: .. toctree:: :maxdepth: 2 - installation - authentication - usage - cli_usage - reference - contributing - testing + install/index + cli/index + contributor/index + reference/index + -Indices and tables -================== +.. rubric:: Indices and tables * :ref:`genindex` * :ref:`modindex` diff --git a/doc/source/installation.rst b/doc/source/install/index.rst index 7b910d2..7b910d2 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/reference.rst b/doc/source/reference/index.rst index 27f83a6..27f83a6 100644 --- a/doc/source/reference.rst +++ b/doc/source/reference/index.rst |