Files
python-searchlightclient/doc/source/index.rst
Steve McLellan c3cf67f5e5 Remove circular TOC reference
The circular reference raises a warning with the current dependency
versions but oslosphinx >=4.0 seems to fail harder on it. Removing the
useless TOC and then empty Reference section.

Change-Id: Iac7d947b6a683f8cdb3b5378c9f82d70a1707d26
2016-10-03 11:05:08 -05:00

35 lines
1.0 KiB
ReStructuredText

Python bindings to the OpenStack Searchlight API
================================================
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
============
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
Man Page
========
.. toctree::
:maxdepth: 1
man/openstack