openstack/whereto
Code Issues Proposed changes

tox: Keeping going with docs

Browse Source 
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
This commit is contained in:
jacky06 2019-10-16 21:20:58 +08:00
parent 701604b832
commit 01a1742476
5 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.rst
View File

@ -1,14 +1,14 @@
If you would like to contribute to the development of OpenStack, you must If you would like to contribute to the development of OpenStack, you must
follow the steps in this page: 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 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 OpenStack accounts are set up, you can skip to the development workflow
section of this documentation to learn how changes to OpenStack should be section of this documentation to learn how changes to OpenStack should be
submitted for review via the Gerrit tool: 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. Pull requests submitted through GitHub will be ignored.

2
HACKING.rst
View File

@ -1,4 +1,4 @@
whereto Style Commandments whereto Style Commandments
=============================================== ==========================
Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/ Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

2
doc/source/index.rst
View File

@ -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 .htaccess file for Apache. It provides a way to test those rules in CI
jobs. jobs.
:Source: http://opendev.org/openstack/whereto :Source: https://opendev.org/openstack/whereto
:Bugs: https://storyboard.openstack.org/#!/project/1037 :Bugs: https://storyboard.openstack.org/#!/project/1037
.. toctree:: .. toctree::

4
test-requirements.txt
View File

@ -5,8 +5,8 @@
hacking>=0.12.0,<0.13 # Apache-2.0 hacking>=0.12.0,<0.13 # Apache-2.0
coverage>=4.0,!=4.4 # 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.8.0,<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.1.0;python_version>='3.4' # BSD
oslotest>=1.10.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT testtools>=1.4.0 # MIT

4
tox.ini
View File

@ -40,12 +40,12 @@ commands = python setup.py test --coverage --testr-args='{posargs}'
[testenv:docs] [testenv:docs]
basepython = python3 basepython = python3
commands = 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] [testenv:releasenotes]
basepython = python3 basepython = python3
commands = 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] [testenv:debug]
basepython = python3 basepython = python3