Browse Source

Increased strictness of the doc build

Warnings are now turned into errors, failing
the doc build. This should prevent any more
syntax issues resulting in malformed, but still syntactically
valid, html output.

To aid with diagnosis of the failures:

The -E flag is now set to rebuild environment
from scratch for each run.

The `-a` flag is set to rebuild all html files,
regardless of their date.

The `--keep-going` flag is set so that the build
doesn't end after encountering first error, but
continues until the bitter end.

Depends-On: https://review.opendev.org/c/openstack/python-tripleoclient/+/789369

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: I591ca3686f72ed6c0426cf272adb8c95330509b5
changes/96/789496/1
Jiri Podivin 5 months ago
parent
commit
cbf1231a08
  1. 2
      tox.ini

2
tox.ini

@ -65,7 +65,7 @@ deps =
-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -b html doc/source doc/build/html
sphinx-build -a -E -W --keep-going -b html doc/source doc/build/html
[testenv:pdf-docs]
whitelist_externals = make

Loading…
Cancel
Save