diff --git a/.gitignore b/.gitignore index 29b5574..e688fa7 100644 --- a/.gitignore +++ b/.gitignore @@ -16,7 +16,7 @@ ChangeLog dist # Doc related doc/build -doc/source/api/ +doc/source/reference/api/ # Development environment files .project .pydevproject diff --git a/doc/source/change_log.rst b/doc/source/change_log.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/change_log.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/conf.py b/doc/source/conf.py index 08fc492..a2ebc85 100644 --- a/doc/source/conf.py +++ b/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. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..c500cec --- /dev/null +++ b/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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 642f1c6..68b235b 100644 --- a/doc/source/index.rst +++ b/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 ================== diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..547ab12 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,8 @@ +======================= + Library API Reference +======================= + +.. toctree:: + :maxdepth: 2 + + api/autoindex diff --git a/doc/source/user/change_log.rst b/doc/source/user/change_log.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/change_log.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..b13e72e --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +=============== + Using osc-lib +=============== + +.. toctree:: + :maxdepth: 2 + + transition + change_log diff --git a/doc/source/transition.rst b/doc/source/user/transition.rst similarity index 100% rename from doc/source/transition.rst rename to doc/source/user/transition.rst diff --git a/setup.cfg b/setup.cfg index f1dbd71..8e04087 100644 --- a/setup.cfg +++ b/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.* \ No newline at end of file