From 5fbbac4e9af665f3b0ea1c1d8d2294fd65295447 Mon Sep 17 00:00:00 2001 From: Nguyen Van Trung Date: Mon, 9 Jul 2018 15:02:05 +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: If77e673564f65879f6f56000444ee7601b44e5bc --- doc/requirements.txt | 6 ++++++ setup.cfg | 6 ------ test-requirements.txt | 7 ------- tox.ini | 3 ++- 4 files changed, 8 insertions(+), 14 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..a3a3f61bf --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# doc build requirements +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinxcontrib-httpdomain>=1.3.0 # BSD +reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 9f5160651..b823bef63 100644 --- a/setup.cfg +++ b/setup.cfg @@ -81,12 +81,6 @@ murano_policy_modify_actions = remove-relation = murano.policy.modify.actions.default_actions:RemoveRelationAction add-relation = murano.policy.modify.actions.default_actions:AddRelationAction -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = 1 - [egg_info] tag_build = tag_date = 0 diff --git a/test-requirements.txt b/test-requirements.txt index e0a65791b..21f6e8505 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -22,10 +22,3 @@ bandit>=1.1.0 # Apache-2.0 # Some of the tests use real MySQL and Postgres databases PyMySQL>=0.7.6 # MIT License psycopg2>=2.6.2 # LGPL/ZPL - -# doc build requirements -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -sphinxcontrib-httpdomain>=1.3.0 # BSD -reno>=2.5.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 -os-api-ref>=1.4.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 90f1c4303..1e92be143 100644 --- a/tox.ini +++ b/tox.ini @@ -52,7 +52,8 @@ commands = [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html [testenv:pyflakes] basepython = python3