From fe1271a182743560920efa0ed6f2595d925dbeb3 Mon Sep 17 00:00:00 2001
From: Adam Spiers <aspiers@suse.com>
Date: Thu, 9 Aug 2018 18:07:10 +0100
Subject: [PATCH] make tox docs environment follow PTI guidelines for sphinx
 build

https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
says:

    Note:

    We strongly discourage project teams from adding commands to the
    docs environment beyond:

        sphinx-build -W -b html doc/source doc/build/html

Discussion on #openstack-doc prompted the suggestion to adjust the
cookiecutter templates accordingly:

http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2018-08-09.log.html#t2018-08-09T16:04:54

Also update requirements.txt.

Change-Id: Ib3733daffb724fa13267aec6ac4f14cb91bcd5ba
---
 {{cookiecutter.repo_name}}/requirements.txt | 4 ++--
 {{cookiecutter.repo_name}}/tox.ini          | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/{{cookiecutter.repo_name}}/requirements.txt b/{{cookiecutter.repo_name}}/requirements.txt
index 152f742..e5567e9 100644
--- a/{{cookiecutter.repo_name}}/requirements.txt
+++ b/{{cookiecutter.repo_name}}/requirements.txt
@@ -1,4 +1,4 @@
-pbr>=0.11,<2.0
+pbr>=2.0.0
 oslosphinx
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
 yasfb>=0.5.1
diff --git a/{{cookiecutter.repo_name}}/tox.ini b/{{cookiecutter.repo_name}}/tox.ini
index be6cbbb..88f46ad 100644
--- a/{{cookiecutter.repo_name}}/tox.ini
+++ b/{{cookiecutter.repo_name}}/tox.ini
@@ -15,7 +15,7 @@ deps = -r{toxinidir}/requirements.txt
 commands = {posargs}
 
 [testenv:docs]
-commands = python setup.py build_sphinx
+commands = sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:spelling]
 deps =