ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-01-31 00:24:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #1033 from tahoe-lafs/3666.sphinx-warnings-are-errors

Browse Source 
Turn sphinx-build's warnings into errors

Fixes: ticket:3666
This commit is contained in:
Sajith Sasidharan 2021-04-12 21:44:19 -04:00 committed by GitHub
commit 964a637156
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
newsfragments/3666.documentation Normal file
View File

@ -0,0 +1 @@
`tox -e docs` will treat warnings about docs as errors.

2
tox.ini
View File

@ -234,7 +234,7 @@ deps =
# normal install is not needed for docs, and slows things down
skip_install = True
commands =
sphinx-build -b html -d {toxinidir}/docs/_build/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
sphinx-build -W -b html -d {toxinidir}/docs/_build/doctrees {toxinidir}/docs {toxinidir}/docs/_build/html
[testenv:pyinstaller]
# We override this to pass --no-use-pep517 because pyinstaller (3.4, at least)