Skip to content
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.

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

LaTeX: fix #13007 #13009

Merged
merged 3 commits into from
Oct 11, 2024
Merged

LaTeX: fix #13007 #13009

merged 3 commits into from
Oct 11, 2024

Conversation

jfbu
Copy link
Contributor

@jfbu jfbu commented Oct 11, 2024

A change at 8.1.0 related to the rendering in PDF of admonitions breaks the build if user LaTeX installation is lacking both of fontawesome5.sty and fontawesome.sty. This is due to a missing update of 7.4.0 auxiliary LaTeX in sphinx.sty related to rendering of title bar icons.

Fix #13007.

Sorry about this oversight. The 7.4.0 was tested with LaTeX environments lacking fontawesome5.sty and fontawesome.sty but the change which got merged into 8.1.0 forgot to do again those tests which would have revealed the issue.

To add a unit test for this is not easy because Sphinx has to be tricked to believe it is lacking a LaTeX dependency which does exist in our CI, so I will return at a later date to incorporate such a test into our CI PDF builds.

To recap: the issue arises only if user LaTeX installation is lacking both of fontawesome5.sty and fontawesome.sty. But note that our documentation says:

At any rate, on Ubuntu for example, following packages must all be present:

  • texlive-latex-recommended
  • texlive-fonts-recommended
  • texlive-fonts-extra (needed for fontawesome5, see the 7.4.0 change notice below)
  • tex-gyre (if latex_engine left to default)
  • texlive-latex-extra
  • latexmk

@AA-Turner Despite the fact that #13007 would not have arisen if the above dependencies had been installed, I opened a 8.1.x milestone, but perhaps we can downgrade the severity of the bug and have this PR merged later. (I had forgotten we did say explictly that on Ubuntu texlive-fonts-extra is required, so the severity of the bug is less than I thought initially).

A change at 8.1.0 related to the rendering in PDF of admonitions broke
the build if user LaTeX installation was lacking both of fontawesome5.sty
and fontawesome.sty.  This was due to a missing change to some
auxiliary LateX in sphinx.sty related to rendering of title bar icons.
@AA-Turner AA-Turner merged commit 61d6e40 into sphinx-doc:master Oct 11, 2024
23 checks passed
@jfbu jfbu deleted the latex_13007 branch October 12, 2024 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Regression in Sphinx 8.1.0: latexpdf: Build failures
2 participants