Skip to content

doc: Fix PDF doc build#638

Merged
finger563 merged 14 commits into
mainfrom
fix/pdf
Jun 13, 2026
Merged

doc: Fix PDF doc build#638
finger563 merged 14 commits into
mainfrom
fix/pdf

Conversation

@finger563

@finger563 finger563 commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

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

Copilot AI review requested due to automatic review settings June 11, 2026 21:48
@github-actions

Copy link
Copy Markdown

✅Static analysis result - no issues found! ✅

@finger563 finger563 self-assigned this Jun 11, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 problematic DoxyEnumFields environment).
  • Switch the GitHub Actions PDF build from xelatex to pdflatex and run the patch step before compiling.
  • Update Doxygen configuration to disable inline sources to reduce LaTeX/PDF fragility; remove the Sphinx latex_engine override.

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.

Comment thread docker_build_docs.sh Outdated
Comment thread .github/workflows/build_and_publish_docs.yml
Comment thread doc/patch_doxygen_latex.py
Comment thread doc/patch_doxygen_latex.py Outdated
Comment thread doc/patch_doxygen_latex.py Fixed
@finger563 finger563 merged commit 67e1937 into main Jun 13, 2026
112 of 113 checks passed
@finger563 finger563 deleted the fix/pdf branch June 13, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants