openstack
/
searchlight-specs
Code Issues Proposed changes

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. The 'wheel' group is renamed to 'bdist_wheel' [2]
3. Update some urls to latest

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
[2] f7c9878712

Change-Id: I3460f2721a662ba4c4c6cc82dead763d6d9932ef
This commit is contained in:
caoyuan 2019-10-24 20:04:09 +08:00
parent b0e5b767f0
commit 327bec69c2
4 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/requirements.txt
View File

@ -1,8 +1,9 @@
# 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.
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,>=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
openstackdocstheme>=1.30.0 # Apache-2.0
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
sphinxcontrib-actdiag>=0.8.5 # BSD

4
setup.cfg
View File

@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack
author-email = openstack-discuss@lists.openstack.org
home-page = http://specs.openstack.org/openstack/searchlight-specs/
home-page = https://specs.openstack.org/openstack/searchlight-specs/
classifier =
Intended Audience :: Developers
License :: OSI Approved :: Apache Software License
@ -19,5 +19,5 @@ source-dir = doc/source
[pbr]
warnerrors = True
[wheel]
[bdist_wheel]
universal = 1

4
test-requirements.txt
View File

@ -9,5 +9,5 @@ flake8
doc8>=0.6.0 # Apache-2.0
pbr!=2.1.0,>=2.0.0
Pillow>=2.4.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,>=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

4
tox.ini
View File

@ -21,7 +21,7 @@ deps = -r{toxinidir}/doc/requirements.txt
whitelist_externals = rm
commands =
rm -fr doc/build
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
sphinx-build -W --keep-going -b html -d doc/build/doctrees doc/source doc/build/html
[testenv:pdf-docs]
basepython = python3
@ -30,7 +30,7 @@ envdir = {toxworkdir}/docs
whitelist_externals =
make
commands =
sphinx-build -W -b latex doc/source doc/build/pdf
sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:pep8]