summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorricolin <rico.lin@easystack.cn>2017-12-19 15:36:06 +0800
committerZane Bitter <zbitter@redhat.com>2018-03-23 10:45:18 -0400
commitf41ad78cd49788bc8589b849a888aeb9bb916997 (patch)
treeb214832d53d7b65efb136681ceda13e40fb28977
parent79242e2e4f7bf86cfeb1f3318147da6525f6a7e8 (diff)
downloadpython-heatclient-f41ad78cd49788bc8589b849a888aeb9bb916997.tar.gz
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html Refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html Change-Id: Ibb35b13fe121fa2489ef31f51e1a662fbd01cc8b Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
-rw-r--r--doc/requirements.txt4
-rw-r--r--setup.cfg7
-rw-r--r--test-requirements.txt3
-rw-r--r--tox.ini9
4 files changed, 11 insertions, 12 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..6889f20
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,4 @@
+openstackdocstheme>=1.18.1 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+sphinxcontrib-httpdomain>=1.3.0 # BSD
diff --git a/setup.cfg b/setup.cfg
index e52e601..c35e777 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -103,13 +103,6 @@ heatclient.resource.formatter.list =
setup-hooks =
pbr.hooks.setup_hook
-[build_sphinx]
-builders = html,man
-all-files = 1
-warning-is-error = 1
-source-dir = doc/source
-build-dir = doc/build
-
[upload_sphinx]
upload-dir = doc/build/html
diff --git a/test-requirements.txt b/test-requirements.txt
index 2d055ed..5fb01ef 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -9,10 +9,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD
requests-mock>=1.2.0 # Apache-2.0
mock>=2.0.0 # BSD
mox3>=0.20.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
python-openstackclient>=3.12.0 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
tempest>=17.1.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
diff --git a/tox.ini b/tox.ini
index 5f8d8b5..c725045 100644
--- a/tox.ini
+++ b/tox.ini
@@ -46,8 +46,10 @@ commands =
coverage report
[testenv:docs]
-commands=
- python setup.py build_sphinx
+deps =
+ -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+ -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -W -b html doc/source doc/build/html
[flake8]
show-source = True
@@ -58,4 +60,7 @@ max-complexity=20
import_exceptions = heatclient._i18n
[testenv:releasenotes]
+deps =
+ -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
+ -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html