Conversation
|
✅Static analysis result - no issues found! ✅ |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adjusts the documentation build pipeline to make the PDF generation path more stable by switching the LaTeX toolchain to pdflatex and applying a post-processing patch to Doxygen’s generated LaTeX style.
Changes:
- Add a Python helper to patch
doxygen.sty(replacing the problematicDoxyEnumFieldsenvironment). - Switch the GitHub Actions PDF build from
xelatextopdflatexand run the patch step before compiling. - Update Doxygen configuration to disable inline sources to reduce LaTeX/PDF fragility; remove the Sphinx
latex_engineoverride.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
docker_build_docs.sh |
Adds a post-build step to patch generated Doxygen LaTeX (path currently inconsistent with the rest of the script). |
doc/patch_doxygen_latex.py |
New utility script that patches doxygen.sty to avoid LaTeX failures around enum fields. |
doc/Doxyfile |
Disables INLINE_SOURCES to reduce LaTeX/PDF build issues from inline code listings. |
doc/conf_common.py |
Removes the latex_engine = 'xelatex' config (now relying on pdflatex workflow). |
.github/workflows/build_and_publish_docs.yml |
Runs the patch step and swaps PDF compilation from xelatex to pdflatex. |
Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
This reverts commit 9fb9ca9.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix how the latex is transformed to PDF in doc build for upload to release
Tested and passed here: https://github.com/esp-cpp/espp/actions/runs/27444489453
espp_documentation 3.pdf