From 7086dc5cc742ad93ed30a8ea0d272830f1cd8961 Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Mon, 19 Mar 2018 16:10:36 +0900
Subject: [PATCH] Follow the new PTI for document build

For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove the '[build_sphinx]' and '[pbr]' sections as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I31dc268d810fd0ddd69a819b925226787da96ebd
---
 doc/requirements.txt  |  3 +++
 doc/source/index.rst  |  7 ++++---
 setup.cfg             | 13 -------------
 test-requirements.txt |  3 ---
 tox.ini               |  8 ++++++--
 5 files changed, 13 insertions(+), 21 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..b9c5e1f
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,3 @@
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5967ac6..b570f33 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -2,7 +2,8 @@
 Welcome to Freezer's client documentation!
 ==========================================
 
-Contents:
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
@@ -10,10 +11,10 @@ Contents:
    cli/index
 
 
-.. rubric:: Indices and tables
+Indices and tables
+------------------
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 
 
diff --git a/setup.cfg b/setup.cfg
index 1807351..02e0746 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -40,19 +40,6 @@ keywords =
 packages =
     freezerclient
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
 [entry_points]
 console_scripts =
     freezer = freezerclient.shell:main
-
-[pbr]
-# Have pbr generate the module indexes like sphinx autodoc
-autodoc_index_modules = True
-
-# Treat sphinx warnings as errors during the docs build; this helps us keep
-# the documentation clean.
-warnerrors = true
diff --git a/test-requirements.txt b/test-requirements.txt
index 3e4e4c9..610ecbc 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,8 +6,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
 coverage!=4.4,>=4.0 # Apache-2.0
 mock>=2.0.0 # BSD
 pylint==1.4.5 # GPLv2
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
-openstackdocstheme>=1.18.1 # Apache-2.0
 testrepository>=0.0.18 # Apache-2.0/BSD
 testtools>=2.2.0 # MIT
-reno>=2.5.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 34cf456..9843cb5 100644
--- a/tox.ini
+++ b/tox.ini
@@ -46,8 +46,8 @@ commands =
     rm -rf .testrepository
 
 [testenv:docs]
-commands =
-  python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -b html doc/source doc/build/html
 
 [testenv:pep8]
 commands = flake8 freezerclient
@@ -70,6 +70,10 @@ exclude = .venv,.tox,dist,doc,*egg,releasenotes
 
 
 [testenv:releasenotes]
+deps =
+    -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+    -r{toxinidir}/requirements.txt
+    -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
 
 [testenv:lower-constraints]