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:
Vishakha Agarwal 2019-09-27 22:23:01 +05:30 committed by Colleen Murphy
parent 732fc6bec7
commit 8f2f2e3827
3 changed files with 10 additions and 9 deletions

View File

@ -1 +0,0 @@
.. include:: ../../ChangeLog

View File

@ -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`

View File

@ -54,7 +54,7 @@ exclude = .venv,.tox,dist,doc,*egg,build
[testenv:docs]
basepython = python3
commands=
python setup.py build_sphinx
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
[testenv:releasenotes]
basepython = python3