Follow the PTI for docs
Use sphinx-build instead of the pbr sphinx extention for building docs as instructed by the PTI[1]. We remove the reference to the ChangeLog file that is usually generated by pbr and instead refer to the published reno release notes. Also fixes the header formatting for the index page, as the headers weren't rendering at all. [1] https://governance.openstack.org/tc/reference/pti/python.html Change-Id: I36142eeb1590c551c6df3bd7d0bc7b7a4a8c692f
This commit is contained in:
parent
732fc6bec7
commit
8f2f2e3827
|
@ -1 +0,0 @@
|
|||
.. include:: ../../ChangeLog
|
|
@ -1,23 +1,25 @@
|
|||
ldappool
|
||||
========
|
||||
|
||||
Contents:
|
||||
Contents
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
.. only:: html
|
||||
|
||||
api/modules
|
||||
|
||||
Release Notes
|
||||
=============
|
||||
--------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
`Release Notes`_
|
||||
|
||||
history
|
||||
.. _Release Notes: https://docs.openstack.org/releasenotes/ldappool/
|
||||
|
||||
Contributing
|
||||
============
|
||||
------------
|
||||
|
||||
Code is hosted `on GitHub`_. Submit bugs to the Keystone project on
|
||||
`Launchpad`_. Submit code to the ``openstack/ldappool`` project
|
||||
|
@ -30,7 +32,7 @@ using `Gerrit`_.
|
|||
Run tests with ``tox``.
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
|
|
Loading…
Reference in New Issue