openstack/nova-specs
Code Issues Proposed changes

Make 'tox -e fast-specs' fail on sphinx warnings

Browse Source 
I'm not sure if others will want this but when I made an edit on my
spec and ran 'tox -e fast-specs', my expectation was that it was a fast
way to check whether the edits I made would pass openstack-tox-docs in
the gate. This turned out not to be the case, 'tox -e fast-specs'
showed the "fast-specs: commands succeeded" message but when I uploaded
the change, the openstack-tox-docs job failed because there was a
sphinx parsing error in my spec.

This adds -W to the sphinx-build call to treat warnings as errors to
match 'tox -e docs' and openstack-tox-docs. It also runs sphinx-build
via exec to make the script fail if sphinx-build returns non-zero.

Change-Id: I9de750e7f44a746d4466c522004d0c2a624052e2
This commit is contained in:
melanie witt 2022-03-31 04:39:15 +00:00
parent 1a20b73634
commit 3c64c66238
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tools/fast-specs.sh
View File

@ -50,7 +50,7 @@ for release in "${!specs_by_release[@]}"; do
bld=doc/build/html/specs/$release
files=${specs_by_release[$release]}
echo "fast-specs: Building for ${release}:$files"
sphinx-build -c doc/source $src $bld $files
exec sphinx-build -W -c doc/source $src $bld $files
# Save the full path to built files. (Wait until the end to output these, so
# they're not lost between subdirectories.)
for f in $files; do