rearrange the existing docs into the new standard layout

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

.gitignore

@@ -17,7 +17,7 @@ etc/*.conf
 etc/*.ini
 AUTHORS
 ChangeLog
-doc/source/api/*
+doc/source/reference/api/*
 doc/build/*
 dist
 designateclient/versioninfo

doc/source/contributor/index.rst

@@ -0,0 +1,8 @@
+====================
+ Contributors Guide
+====================
+
+.. toctree::
+
+   contributing
+   functional-tests

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
+   install/index
-   bindings
+   user/index
-   shell-v2
+   contributor/index
-   shell
+   reference/index
-   shell-examples
-   contributing
-   functional-tests
-   api/autoindex
 
-Indices and tables
+.. rubric:: Indices and tables
-==================
 
 * :ref:`genindex`
 * :ref:`modindex`

doc/source/reference/index.rst

@@ -0,0 +1,7 @@
+==================================
+ python-designateclient Reference
+==================================
+
+.. toctree::
+
+   api/autoindex

doc/source/user/bindings.rst

@@ -1,3 +1,5 @@
+.. _bindings:
+
 ===========================
 Python Bindings - v1 and v2
 ===========================

doc/source/user/index.rst

@@ -0,0 +1,10 @@
+==============================
+ Using python-designateclient
+==============================
+
+.. toctree::
+
+   bindings
+   shell-v2
+   shell
+   shell-examples

doc/source/user/shell-v2.rst

@@ -1,3 +1,5 @@
+.. _shell-v2:
+
 ===========================
 OpenStack CLI (v2 API only)
 ===========================

doc/source/user/shell.rst

@@ -1,3 +1,5 @@
+.. _shell:
+
 =========================================================
 Designate Command Line Tool (compatible with v1 API only)
 =========================================================

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.*