From 8f2f2e3827d36c06932a3e9691f3a75f1cfb94be Mon Sep 17 00:00:00 2001
From: Vishakha Agarwal <agarwalvishakha18@gmail.com>
Date: Fri, 27 Sep 2019 22:23:01 +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].

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
---
 doc/source/history.rst |  1 -
 doc/source/index.rst   | 16 +++++++++-------
 tox.ini                |  2 +-
 3 files changed, 10 insertions(+), 9 deletions(-)
 delete mode 100644 doc/source/history.rst

diff --git a/doc/source/history.rst b/doc/source/history.rst
deleted file mode 100644
index 69ed4fe..0000000
--- a/doc/source/history.rst
+++ /dev/null
@@ -1 +0,0 @@
-.. include:: ../../ChangeLog
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 7e83576..fca5313 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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`
diff --git a/tox.ini b/tox.ini
index 0f28ada..004534c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -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