From 5aae14a9c8d22c3e3fff245f6f0a0a1008374ba3 Mon Sep 17 00:00:00 2001 From: Nguyen Van Trung Date: Mon, 2 Jul 2018 15:59:45 +0700 Subject: [PATCH] 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 --- doc/requirements.txt | 6 ++++++ setup.cfg | 8 +------- test-requirements.txt | 4 ---- tox.ini | 4 +++- 4 files changed, 10 insertions(+), 12 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..86fc0cb553 --- /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 ea9cc16200..d2ab28b9fa 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 cb9b38f033..8b073fa5dd 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 cf56f83b03..6a1824da1c 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]