Skip to content

Catch Sphinx build errors in CI #4751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Nov 4, 2025
Merged

Catch Sphinx build errors in CI #4751

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
969fed9
Catch Sphinx build errors in CI
atmyers Nov 3, 2025
49954d3
Merge branch 'development' into catch_sphinx_errors
atmyers Nov 3, 2025
0302482
only link to the pdf if we are building for html
atmyers Nov 3, 2025
485a126
only catch warnings for html
atmyers Nov 3, 2025
4ebdaf2
break again as test
atmyers Nov 3, 2025
6270ea6
make clean and don't eat output
atmyers Nov 3, 2025
1fbb4f8
put table back
atmyers Nov 3, 2025
e004711
fix doxygen
atmyers Nov 3, 2025
0a734ba
Cosmetic changes
atmyers Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ cd ../..
cd Docs/sphinx_documentation

echo "Build the Sphinx documentation for Amrex."
make PYTHON="python3" latexpdf
make SPHINXOPTS='-v -W --keep-going' PYTHON="python3" latexpdf
mv build/latex/amrex.pdf source/
make PYTHON="python3" html &> make_source_html.out
make SPHINXOPTS='-v -W --keep-going' PYTHON="python3" html &> make_source_html.out
Copy link
Member

@WeiqunZhang WeiqunZhang Nov 3, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should remove &> make_source_html.out so that we can actually see the output and error.

Copy link
Member

@WeiqunZhang WeiqunZhang Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also need to build html first to treat warnings as errors, if we ignore the warnings from latexpdf. Or we do make clean before make html.

Copy link
Member

@WeiqunZhang WeiqunZhang Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make html was reusing the results of make latexpdf. That was why it did not break.

Copy link
Member Author

@atmyers atmyers Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current code breaks. Now let me fix the table again.

cd ../../

mkdir build
Expand Down
Loading