Andreas Jaeger a9d01eef93 Fix docs publishing
Use sphinx-build so that the output happens in the right place.

Remove ChangeLog, instead link to the release notes.
Use apidoc for API doc building.

Fix main index page display so that title has higher level,
use link to OpenDev.

Change-Id: Iaa8d7f2143d411be31ad10b546455f18015566f3
2020-04-15 11:53:00 +02:00

56 lines
1.4 KiB
ReStructuredText

========================================================
Python bindings to the OpenStack Identity API (Keystone)
========================================================
This is a client for OpenStack Identity API. There's a Python API for
:doc:`Identity API v3 <using-api-v3>` and :doc:`v2 <using-api-v2>` (the
:mod:`keystoneclient` modules).
Contents:
.. toctree::
:maxdepth: 1
using-api-v3
using-sessions
using-api-v2
api/modules
Related Identity Projects
=========================
In addition to creating the Python client library, the Keystone team also
provides `Identity Service`_, as well as `WSGI Middleware`_.
.. _`Identity Service`: https://docs.openstack.org/keystone/latest/
.. _`WSGI Middleware`: https://docs.openstack.org/keystonemiddleware/latest/
Release Notes
=============
Read also the `Keystoneclient Release Notes
<https://docs.openstack.org/releasenotes/python-keystoneclient/>`_.
Contributing
============
Code is hosted `on OpenDev`_. Submit bugs to the Keystone project on
`Launchpad`_. Submit code to the ``openstack/python-keystoneclient`` project
using `Gerrit`_.
.. _on OpenDev: https://opendev.org/openstack/python-keystoneclient
.. _Launchpad: https://launchpad.net/python-keystoneclient
.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
Run tests with ``tox``.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`