From 01a17424761ed1d38ca3af41c4223425a5fbc75c Mon Sep 17 00:00:00 2001 From: jacky06 Date: Wed, 16 Oct 2019 21:20:58 +0800 Subject: [PATCH] tox: Keeping going with docs 1. Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. 2. remove the unnecessary == 3. update the url to latest [1] sphinx-doc/sphinx@e3483e9 Change-Id: I337c1f756dde3ff6277b1e8d1ad1e3eff49a7e47 --- CONTRIBUTING.rst | 4 ++-- HACKING.rst | 2 +- doc/source/index.rst | 2 +- test-requirements.txt | 4 ++-- tox.ini | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c0b12cb..2461e4f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,14 +1,14 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: -http://docs.openstack.org/infra/manual/developers.html +https://docs.openstack.org/infra/manual/developers.html If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool: -http://docs.openstack.org/infra/manual/developers.html#development-workflow +https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. diff --git a/HACKING.rst b/HACKING.rst index 257b3ee..d8367da 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -1,4 +1,4 @@ whereto Style Commandments -=============================================== +========================== Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ diff --git a/doc/source/index.rst b/doc/source/index.rst index 98b3fbc..3c5bb80 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,7 +6,7 @@ whereto is an app for testing redirect rules like what may appear in a .htaccess file for Apache. It provides a way to test those rules in CI jobs. -:Source: http://opendev.org/openstack/whereto +:Source: https://opendev.org/openstack/whereto :Bugs: https://storyboard.openstack.org/#!/project/1037 .. toctree:: diff --git a/test-requirements.txt b/test-requirements.txt index 63dc2f2..48fd5d5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,8 +5,8 @@ hacking>=0.12.0,<0.13 # Apache-2.0 coverage>=4.0,!=4.4 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT diff --git a/tox.ini b/tox.ini index 87c269e..6a4fbbe 100644 --- a/tox.ini +++ b/tox.ini @@ -40,12 +40,12 @@ commands = python setup.py test --coverage --testr-args='{posargs}' [testenv:docs] basepython = python3 commands = - sphinx-build -b html -W doc/source doc/build/html + sphinx-build --keep-going -b html -W doc/source doc/build/html [testenv:releasenotes] basepython = python3 commands = - sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html [testenv:debug] basepython = python3