summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-28 17:15:45 -0400
committerDoug Hellmann <doug@doughellmann.com>2017-07-10 11:50:21 -0400
commit3241a7d9c47844a234dce61ed5c16daec13f7017 (patch)
tree6940ab32210befbc5fa4f85ae20f963f305f0f41 /doc/source
parentc6705f4e0bcb7d52061e68c1622ed74ec1d24b05 (diff)
downloadpython-designateclient-3241a7d9c47844a234dce61ed5c16daec13f7017.tar.gz
rearrange the existing docs into the new standard layout
Change-Id: I1cf25aade215aad3ce9050af7c9fa8987564863c Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/contributor/contributing.rst (renamed from doc/source/contributing.rst)0
-rw-r--r--doc/source/contributor/functional-tests.rst (renamed from doc/source/functional-tests.rst)0
-rw-r--r--doc/source/contributor/index.rst8
-rw-r--r--doc/source/index.rst26
-rw-r--r--doc/source/install/index.rst (renamed from doc/source/installation.rst)0
-rw-r--r--doc/source/reference/index.rst7
-rw-r--r--doc/source/user/bindings.rst (renamed from doc/source/bindings.rst)2
-rw-r--r--doc/source/user/index.rst10
-rw-r--r--doc/source/user/shell-examples.rst (renamed from doc/source/shell-examples.rst)0
-rw-r--r--doc/source/user/shell-v2.rst (renamed from doc/source/shell-v2.rst)2
-rw-r--r--doc/source/user/shell.rst (renamed from doc/source/shell.rst)2
11 files changed, 40 insertions, 17 deletions
diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst
index 578e8a1..578e8a1 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/contributing.rst
diff --git a/doc/source/functional-tests.rst b/doc/source/contributor/functional-tests.rst
index 3726eb9..3726eb9 100644
--- a/doc/source/functional-tests.rst
+++ b/doc/source/contributor/functional-tests.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..2ee634f
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,8 @@
+====================
+ Contributors Guide
+====================
+
+.. toctree::
+
+ contributing
+ functional-tests
diff --git a/doc/source/index.rst b/doc/source/index.rst
index cabe976..6d6d48d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -5,38 +5,30 @@ python-designateclient
python-designateclient provides python bindings and command line tools for both
Designate v1 and v2 APIs.
-The :doc:`Python API bindings <bindings>` are provided by the
+The :ref:`Python API bindings <bindings>` are provided by the
:program:`designateclient` module.
There are two separate command line interfaces to work with the two API
versions:
v2: the designate plugin for the :program:`openstack` command line tool. More information can be
-found on the :doc:`designate v2 command line tool page <shell-v2>`.
+found on the :ref:`designate v2 command line tool page <shell-v2>`.
v1: the :program:`designate` command line tool. More information can be found
-on the :doc:`designate v1 command line tool page <shell>`.
+on the :ref:`designate v1 command line tool page <shell>`.
You'll need credentials for an OpenStack cloud that implements the Designate
API in order to use the client.
-Contents
-======================
-
.. toctree::
:maxdepth: 1
- installation
- bindings
- shell-v2
- shell
- shell-examples
- contributing
- functional-tests
- api/autoindex
-
-Indices and tables
-==================
+ install/index
+ user/index
+ contributor/index
+ reference/index
+
+.. rubric:: Indices and tables
* :ref:`genindex`
* :ref:`modindex`
diff --git a/doc/source/installation.rst b/doc/source/install/index.rst
index 1d6f83b..1d6f83b 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..331be17
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,7 @@
+==================================
+ python-designateclient Reference
+==================================
+
+.. toctree::
+
+ api/autoindex
diff --git a/doc/source/bindings.rst b/doc/source/user/bindings.rst
index fdaef0c..f00eff0 100644
--- a/doc/source/bindings.rst
+++ b/doc/source/user/bindings.rst
@@ -1,3 +1,5 @@
+.. _bindings:
+
===========================
Python Bindings - v1 and v2
===========================
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..2602651
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,10 @@
+==============================
+ Using python-designateclient
+==============================
+
+.. toctree::
+
+ bindings
+ shell-v2
+ shell
+ shell-examples
diff --git a/doc/source/shell-examples.rst b/doc/source/user/shell-examples.rst
index 3213fb1..3213fb1 100644
--- a/doc/source/shell-examples.rst
+++ b/doc/source/user/shell-examples.rst
diff --git a/doc/source/shell-v2.rst b/doc/source/user/shell-v2.rst
index 93e06e7..b3a9bf0 100644
--- a/doc/source/shell-v2.rst
+++ b/doc/source/user/shell-v2.rst
@@ -1,3 +1,5 @@
+.. _shell-v2:
+
===========================
OpenStack CLI (v2 API only)
===========================
diff --git a/doc/source/shell.rst b/doc/source/user/shell.rst
index 2f86a9e..3217ae6 100644
--- a/doc/source/shell.rst
+++ b/doc/source/user/shell.rst
@@ -1,3 +1,5 @@
+.. _shell:
+
=========================================================
Designate Command Line Tool (compatible with v1 API only)
=========================================================