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
WeiqunZhang merged 9 commits into from
Nov 4, 2025
Merged

Catch Sphinx build errors in CI #4751

Changes from all commits
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
27 changes: 14 additions & 13 deletions build_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash
set -e # Exit with nonzero exit code if anything fails

# Doxygen
# Build Doxygen
echo "Build the Doxygen documentation"
cd Docs/Doxygen
doxygen doxygen.conf &> doxygen.out
Expand All @@ -12,26 +12,27 @@ if grep -q "warning:" doxygen.out; then
fi
cd ../..

# sphinx
cd Docs/sphinx_documentation

echo "Build the Sphinx documentation for Amrex."
make PYTHON="python3" latexpdf
mv build/latex/amrex.pdf source/
make PYTHON="python3" html &> make_source_html.out
cd ../../

# copy doxygen to target location
mkdir build
cd build
mkdir docs_html docs_xml

# add doxygen
mkdir -p docs_html/doxygen
cp -rp ../Docs/Doxygen/html/* docs_html/doxygen/
mkdir -p docs_xml/doxygen
cp -rp ../Docs/Doxygen/xml/* docs_xml/doxygen/
# add tagfile to allow other docs to interlink with amrex
cp ../Docs/Doxygen/amrex-doxygen-web.tag.xml docs_xml/doxygen/.
cd ..

# add sphinx
# Build sphinx
cd Docs/sphinx_documentation
echo "Build the Sphinx documentation for Amrex."
make PYTHON="python3" latexpdf
mv build/latex/amrex.pdf source/
make clean
make SPHINXOPTS='-v -W --keep-going' PYTHON="python3" html
cd ../../

# copy sphinx to target location
cd build
cp -rp ../Docs/sphinx_documentation/build/html/* docs_html/
Loading