Documentation build doesn't check for Doxygen failure
Description
The build.py
script used to build the documentation does not check for errors from Doxygen.
This leads to the script continuing to execute even when Doxygen has failed due to an error in generating the documentation.
If the documentation has already been built successfully previously, then the build script will succeed and claim the documentation was built despite the generation being incomplete.
How to Reproduce
-
Ensure that the
docs/_build
directory does not exist -
Edit
docs/index.md
and add on line 4 some text that will cause an error, for example:[Link to something]{#this-ref-doesnt-exist}
-
Execute the build script.
./docs/.doxygen/build.py
-
Observe that the build script fails due to a missing file (
searchdata.xml
), which is required bybuild.py
after the doxygen step completes, but was not generated because doxygen did not complete.
Current Behavior
Doxygen failing to complete successfully does not cause the build.py
script to abort.
Expected behavior
Doxygen failing should cause the build.py
script to abort due to the error.