diff --git a/doc/source/contribute/index.rst b/doc/source/contribute/index.rst new file mode 100644 index 0000000..d40248f --- /dev/null +++ b/doc/source/contribute/index.rst @@ -0,0 +1,20 @@ +============ +Contributing +============ + +Code is hosted at `git.openstack.org`_. Submit bugs to the searchlight project +on `Launchpad`_. Submit code to the openstack/python-searchlightclient project +using `Gerrit`_. + +.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-searchlightclient +.. _Launchpad: https://launchpad.net/python-searchlightclient +.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Testing +------- + +The preferred way to run the unit tests is using ``tox``. + +See `Consistent Testing Interface`_ for more details. + +.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 5095912..0159d4c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,25 +5,12 @@ This is a client for OpenStack Searchlight API. There's a Python API (the :mod:`searchlightclient` module), and a command-line script (installed as :program:`openstack`). -Contributing -============ +Contents: -Code is hosted at `git.openstack.org`_. Submit bugs to the searchlight project -on `Launchpad`_. Submit code to the openstack/python-searchlightclient project -using `Gerrit`_. +.. toctree:: + :maxdepth: 2 -.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-searchlightclient -.. _Launchpad: https://launchpad.net/python-searchlightclient -.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow - -Testing -------- - -The preferred way to run the unit tests is using ``tox``. - -See `Consistent Testing Interface`_ for more details. - -.. _Consistent Testing Interface: http://git.openstack.org/cgit/openstack/governance/tree/reference/project-testing-interface.rst + contribute/index Man Page ========