From 30b20b6e048aa0879e2116d17542cde8949219f4 Mon Sep 17 00:00:00 2001 From: Vishakha Agarwal Date: Fri, 27 Sep 2019 14:37:56 +0530 Subject: [PATCH] Follow the PTI for docs 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 --- doc/source/index.rst | 5 +++-- tox.ini | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 80d2267..7807170 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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` diff --git a/tox.ini b/tox.ini index de73d26..07c94cc 100644 --- a/tox.ini +++ b/tox.ini @@ -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