Skip to content

Build: remove pdflatex support #9967

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

Merged
merged 5 commits into from
Feb 7, 2023
Merged

Conversation

humitos
Copy link
Member

@humitos humitos commented Jan 31, 2023

pdflatex is only called for project using Sphinx<=1.6.1 --which we haven't had anyone in the last 6 months.

Closes #9886

`pdflatex` is only called for project using `Sphinx<=1.6.1` --which we haven't
had anyone in the last 6 months.

Closes #9886
@humitos humitos requested a review from a team as a code owner January 31, 2023 15:49
@humitos humitos requested a review from stsewd January 31, 2023 15:49
@humitos humitos requested a review from a team as a code owner January 31, 2023 15:51
@humitos humitos requested a review from benjaoming January 31, 2023 15:51
Copy link
Contributor

@benjaoming benjaoming left a comment

Choose a reason for hiding this comment

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

LGTM 👍 (seems maybe some tests need to be sync'ed with the new/fewer commands being called)

Just want your opinion about whether this is definitely breaking super-old environments with Sphinx<1.6 and if that can be avoided by simply not calling latexmk in those environments ⬇️

@@ -3,8 +3,6 @@ Sphinx PDFs with Unicode

Sphinx offers different `LaTeX engines`_ that have better support for Unicode characters
and non-European languages like Japanese or Chinese.
By default Sphinx uses ``pdflatex``,
which does not have good support for Unicode characters and may make the PDF builder fail.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we keep "By default, Sphinx uses latexmk <https://mg.readthedocs.io/latexmk.html>_" or something similar?

I'm not sure how it affects Unicode characters, so seems good to delete.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, latexmk is the good one to deal with Unicode characters. That's why I deleted the sentence completely.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, I was thinking that it's nice to inform people about the default builder in case they need to troubleshoot something.

@humitos
Copy link
Member Author

humitos commented Feb 7, 2023

@agjohnson @ericholscher I'd like your opinions on this because I may not be considering something that you will 😄

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

This seems like a positive change and simplification. I don't have a full memory of why this was added, but I think it should be safe to delete at this point.

We should likely have somewhere in our docs that we mention supported versions of Sphinx, and begrudgingly list 1.8.7 or whatever is the one we install still by default on old projects, until we can migrate them. 🙃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Builder: remove PDF support for Sphinx<=1.6.1
3 participants