summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean McGinnis <sean.mcginnis@huawei.com>2018-03-21 15:34:16 -0500
committerSean McGinnis <sean.mcginnis@huawei.com>2018-03-21 15:59:01 -0500
commit7d250abe0403b0bde7f61becc8f7c7f6f52ca1af (patch)
tree601be4334a9df99bea0da414e0eb3f18b234faba
parent8d406fe9251853f15a7da1df2d2031cca0647267 (diff)
downloadoslo-config-7d250abe0403b0bde7f61becc8f7c7f6f52ca1af.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 For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I46a861f88166b3b2de0a532cc88beef1ef91ab89
-rw-r--r--doc/requirements.txt9
-rw-r--r--setup.cfg9
-rw-r--r--test-requirements.txt4
-rw-r--r--tox.ini5
4 files changed, 14 insertions, 13 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..2980a2d
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,9 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+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
+fixtures>=3.0.0 # Apache-2.0/BSD
+doc8>=0.6.0 # Apache-2.0
diff --git a/setup.cfg b/setup.cfg
index c8e1917..9df6c52 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -33,14 +33,5 @@ console_scripts =
oslo.config.opts =
oslo.config = oslo_config._list_opts:list_opts
-[build_sphinx]
-all-files = 1
-warning-is-error = 1
-source-dir = doc/source
-build-dir = doc/build
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
[wheel]
universal = 1
diff --git a/test-requirements.txt b/test-requirements.txt
index ab8904a..94e75fa 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -14,10 +14,8 @@ oslotest>=3.2.0 # Apache-2.0
# deps = {[testenv]deps} coverage
coverage!=4.4,>=4.0 # Apache-2.0
-# this is required for the docs build jobs
+# this is required for the sphinx extension
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
# mocking framework
mock>=2.0.0 # BSD
diff --git a/tox.ini b/tox.ini
index fa3c59e..d766d8a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -28,7 +28,9 @@ commands =
commands = {posargs}
[testenv:docs]
-commands = python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands =
+ sphinx-build -W -b html doc/source doc/build/html
[testenv:bandit]
commands = bandit -r oslo_config -x tests -n5
@@ -47,6 +49,7 @@ deps = pip_missing_reqs
commands = pip-missing-reqs -d --ignore-module=oslo_config* --ignore-module=pkg_resources --ignore-file=oslo_config/tests/* --ignore-file=tests/ oslo_config
[testenv:releasenotes]
+deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[hacking]