Skip to content

Let LaTeX writer support the standard role "acronym".#14202

Merged
jfbu merged 4 commits intosphinx-doc:masterfrom
gmilde:latex
Dec 22, 2025
Merged

Let LaTeX writer support the standard role "acronym".#14202
jfbu merged 4 commits intosphinx-doc:masterfrom
gmilde:latex

Conversation

@gmilde
Copy link
Contributor

@gmilde gmilde commented Dec 20, 2025

Purpose

Prevent aborting LaTeX generation with "severe" error when a document uses the standard role
"acronym" .

Handle the "acronym" standard role similar to "abbreviation" - cf. the recommendation for HTML.

References

Closes #14050 "LaTeXTranslator fails to build documents using the "acronym" standard role."

Handle the "acronym" standard role
<https://docutils.sourceforge.io/docs/ref/rst/roles.html#acronym>
similar to "abbreviation" - just like in HTML
<https://html.spec.whatwg.org/multipage/obsolete.html#acronym>.

Closes sphinx-doc#14050 "LaTeXTranslator fails to build documents using
the "acronym" standard role."
@gmilde
Copy link
Contributor Author

gmilde commented Dec 20, 2025

The "lint with ty" check fails on parts that were not changed in the commit.

@jfbu jfbu self-assigned this Dec 20, 2025
@jfbu jfbu added this to the 9.1.0 milestone Dec 20, 2025
Copy link
Contributor

@jfbu jfbu left a comment

Choose a reason for hiding this comment

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

Thanks, could you please add a CHANGES.rst entry (I guess it should go into Bugs fixed), so we can merge this in time for 9.1.0 release?

@gmilde
Copy link
Contributor Author

gmilde commented Dec 22, 2025

Thanks, could you please add a CHANGES.rst entry (I guess it should go into Bugs fixed), so we can merge this in time for 9.1.0 release?

Done. I also added my name to the contributors list.
Feel free to merge the commits into one.

TODO: trailing whitespace should be flagged or removed by a commit hook.
@jfbu jfbu merged commit e5cacbc into sphinx-doc:master Dec 22, 2025
27 of 28 checks passed
@jfbu
Copy link
Contributor

jfbu commented Dec 22, 2025

Done. I also added my name to the contributors list. Feel free to merge the commits into one.

Thanks. Btw, our modus operandi here is that we squash all PRs as part of the merge process. This is a small annoyance to the contributor because they have then to force delete the branch (git branch -D) at their locale to clean up their fork after pulling back the upstream master.

@gmilde gmilde deleted the latex branch December 22, 2025 11:06
@jfbu
Copy link
Contributor

jfbu commented Dec 22, 2025

I merged despite some CI failures, but they are unrelated to this patch, and are present since a number of commits added to master branch, I anticipate @AA-Turner will fix these issues for 9.1.0 release.

AA-Turner pushed a commit to pradyunsg/sphinx that referenced this pull request Dec 31, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

LaTeXTranslator fails to build documents using the "acronym" standard role.

2 participants