rearrange the existing docs into the new standard layout

Change-Id: I1cf25aade215aad3ce9050af7c9fa8987564863c
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

13 files changed, 45 insertions, 18 deletions

diff --git a/.gitignore b/.gitignore
index 9c56352..d2b698d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -17,7 +17,7 @@ etc/*.conf
 etc/*.ini
 AUTHORS
 ChangeLog
-doc/source/api/*
+doc/source/reference/api/*
 doc/build/*
 dist
 designateclient/versioninfo
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)
 =========================================================
diff --git a/setup.cfg b/setup.cfg
index 89058e0..72e7e51 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -178,3 +178,7 @@ universal = 1
 
 [pbr]
 autodoc_index_modules = True
+api_doc_dir = reference/api
+autodoc_exclude_modules =
+  designateclient.tests.*
+  designateclient.functionaltests.*