rearrange existing documentation to fit the new standard layout

Change-Id: I91657e96ef29f8b36b2089a11c9c4966418cfcdb
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

.gitignore

@@ -16,7 +16,7 @@ ChangeLog
 dist
 # Doc related
 doc/build
-doc/source/api/
+doc/source/reference/api/
 # Development environment files
 .project
 .pydevproject

doc/source/change_log.rst

@@ -1 +0,0 @@
-.. include:: ../../ChangeLog

doc/source/conf.py

@@ -37,7 +37,6 @@ extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.doctest',
               'sphinx.ext.todo',
               'oslosphinx',
-              'ext.apidoc',
               ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/source/contributor/index.rst

@@ -0,0 +1,19 @@
+==============
+ Contributing
+==============
+
+osc-lib utilizes all of the usual OpenStack processes and requirements for
+contributions.  The code is hosted `on OpenStack's Git server`_. `Bug reports`_
+and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
+on `Launchpad`_.  Code may be submitted to the
+:code:`openstack/osc-lib` project using `Gerrit`_.
+Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
+
+.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
+.. _Launchpad: https://launchpad.net/python-openstackclient
+.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
+.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
+.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
+.. _PyPi: https://pypi.python.org/pypi/osc-lib
+.. _tarball: http://tarballs.openstack.org/osc-lib
+.. _IRC channel: https://wiki.openstack.org/wiki/IRC

doc/source/index.rst

@@ -8,36 +8,11 @@ is a package of common support modules for writing OSC plugins.
 Contents:
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
-   transition
-
-Contributing
-============
-
-osc-lib utilizes all of the usual OpenStack processes and requirements for
-contributions.  The code is hosted `on OpenStack's Git server`_. `Bug reports`_
-and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
-on `Launchpad`_.  Code may be submitted to the
-:code:`openstack/osc-lib` project using `Gerrit`_.
-Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
-
-.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
-.. _Launchpad: https://launchpad.net/python-openstackclient
-.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
-.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
-.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
-.. _PyPi: https://pypi.python.org/pypi/osc-lib
-.. _tarball: http://tarballs.openstack.org/osc-lib
-.. _IRC channel: https://wiki.openstack.org/wiki/IRC
-
-Change Log
-==========
-
-.. toctree::
-   :maxdepth: 1
-
-   change_log
+   user/index
+   reference/index
+   contributor/index
 
 Indices and tables
 ==================

doc/source/reference/index.rst

@@ -0,0 +1,8 @@
+=======================
+ Library API Reference
+=======================
+
+.. toctree::
+   :maxdepth: 2
+
+   api/autoindex

doc/source/user/change_log.rst

@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog

doc/source/user/index.rst

@@ -0,0 +1,9 @@
+===============
+ Using osc-lib
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   transition
+   change_log

setup.cfg

@@ -26,3 +26,10 @@ packages =
 source-dir = doc/source
 build-dir = doc/build
 all_files = 1
+#warning-is-error = 1
+
+[pbr]
+autodoc_index_modules = True
+api_doc_dir = reference/api
+autodoc_exclude_modules =
+  osc_lib.tests.*