From 33339cdd4edd7dba0dfb04a85ec5e7c35b9d0d6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Magimel?= Date: Thu, 26 Jul 2018 21:04:56 +0200 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#documentation http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove the '[build_sphinx]' as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I255b0892a3b0ec0e528172ae2ddabf8abfa507a8 --- doc/requirements.txt | 7 +++++++ doc/source/conf.py | 2 +- setup.cfg | 5 ----- test-requirements.txt | 3 --- tox.ini | 4 +++- 5 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..4971ad1 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +# 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. + +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index a98caca..a5753e1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -133,7 +133,7 @@ html_theme = 'openstackdocs' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/setup.cfg b/setup.cfg index 44ff120..b385c50 100644 --- a/setup.cfg +++ b/setup.cfg @@ -23,10 +23,5 @@ classifier = packages = cloudkittydashboard -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - [upload_sphinx] upload-dir = doc/build/html diff --git a/test-requirements.txt b/test-requirements.txt index 2b3b23f..15985e6 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,10 +6,7 @@ hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0 coverage>=3.6 discover python-subunit>=0.0.18 -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 stestr>=2.0.0 # Apache-2.0 testscenarios>=0.4 testtools>=1.4.0 -reno>=1.8.0 # Apache2 diff --git a/tox.ini b/tox.ini index 99ea147..9ab90b5 100644 --- a/tox.ini +++ b/tox.ini @@ -29,7 +29,8 @@ commands = coverage xml -o cover/coverage.xml [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:debug] commands = oslo_debug_helper -t cloudkittydashboard/tests {posargs} @@ -43,4 +44,5 @@ builtins = _ exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,.ropeproject,releasenotes [testenv:releasenotes] +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html