summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyen Van Trung <trungnv@vn.fujitsu.com>2018-07-02 15:59:45 +0700
committerNguyen Van Trung <trungnv@vn.fujitsu.com>2018-09-06 13:07:06 +0700
commit5aae14a9c8d22c3e3fff245f6f0a0a1008374ba3 (patch)
treec42eb20f76e3e85da0236b9d352f1ffa8f8ccd26
parentcb8aee3945771505bce6e8d874efd5df7e30257a (diff)
downloadceilometer-5aae14a9c8d22c3e3fff245f6f0a0a1008374ba3.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 details information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Ibdd264f0ef0c27762d47a70da192a858e62074a9
-rw-r--r--doc/requirements.txt6
-rw-r--r--setup.cfg8
-rw-r--r--test-requirements.txt4
-rw-r--r--tox.ini4
4 files changed, 10 insertions, 12 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 00000000..86fc0cb5
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,6 @@
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+sphinxcontrib-httpdomain>=1.3.0 # BSD
+sphinxcontrib-blockdiag>=1.5.4 # BSD
+reno>=2.5.0 # Apache-2.0
+os-api-ref>=1.4.0 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/setup.cfg b/setup.cfg
index ea9cc162..d2ab28b9 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -270,13 +270,7 @@ oslo.config.opts =
ceilometer-auth = ceilometer.opts:list_keystoneauth_opts
[build_sphinx]
-all_files = 1
-build-dir = doc/build
-source-dir = doc/source
-
-[pbr]
-warnerrors = true
-autodoc_index_modules = true
+warning-is-error = False
[extract_messages]
keywords = _ gettext ngettext l_ lazy_gettext
diff --git a/test-requirements.txt b/test-requirements.txt
index cb9b38f0..8b073fa5 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,13 +6,9 @@ coverage>=3.6 # Apache-2.0
fixtures<2.0,>=1.3.1 # Apache-2.0/BSD
mock>=1.2 # BSD
os-win>=0.2.3 # Apache-2.0
-# Docs Requirements
-openstackdocstheme>=1.11.0 # Apache-2.0
-reno>=1.6.2 # Apache2
oslotest>=2.15.0 # Apache-2.0
oslo.vmware>=1.16.0 # Apache-2.0
pyOpenSSL>=0.14 # Apache-2.0
-sphinx>=1.6.2 # BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
gabbi>=1.30.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index cf56f83b..6a1824da 100644
--- a/tox.ini
+++ b/tox.ini
@@ -39,6 +39,7 @@ commands =
[testenv:releasenotes]
basepython = python3
+deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:genconfig]
@@ -47,7 +48,8 @@ commands = oslo-config-generator --config-file=etc/ceilometer/ceilometer-config-
[testenv:docs]
basepython = python3
-commands = python setup.py build_sphinx
+deps = -r{toxinidir}/doc/requirements.txt
+commands = sphinx-build -b html doc/source doc/build/html
setenv = PYTHONHASHSEED=0
[testenv:venv]