openstack/keystone-tempest-plugin
Code Issues Proposed changes

Follow the PTI for docs

Browse Source 
Use sphinx-build instead of the pbr sphinx extention for building docs
as instructed by the PTI[1].

It 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: Ibac2b45ecfab4a7e575d097ecb9fc2c5e57b81cf
This commit is contained in:
Vishakha Agarwal 2019-09-27 14:37:56 +05:30
parent 806103f188
commit 30b20b6e04
2 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/index.rst
View File

@ -6,7 +6,8 @@
Welcome to openstack's documentation!
========================================================
Contents:
Contents
--------
.. toctree::
:maxdepth: 2
@ -17,7 +18,7 @@ Contents:
contributing
Indices and tables
==================
-------------------
* :ref:`genindex`
* :ref:`modindex`

2
tox.ini
View File

@ -26,7 +26,7 @@ commands = python setup.py test --coverage --testr-args='{posargs}'
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
commands = sphinx-build -W -b html -d doc/buld/doctrees doc/source doc/build/html
[testenv:releasenotes]
basepython = python3