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: use current parskip package for better spacing around titles #12833

Merged
merged 2 commits into from
Oct 5, 2024

Conversation

jfbu
Copy link
Contributor

@jfbu jfbu commented Aug 27, 2024

For years now we have been using LaTeX parskip v1 version. But this old package adds extra spacing around section titles which is definitely not good.

This was done at #5964 because (as reported in #5960) the parskip package changed suddenly its behavior in 2018 and as a result people could see their projects on RTD give different results from compiling at their locale due to one location using the new and nother location using the old parskip (definitely the new parskip should have been released as parskip2, i.e. not keep the same name).

2018 is now 6 years ago.

I think it is time to use the currently maintained parskip version not the earlier version from 2001 (and even earlier).

This will change all PDFs to have less exaggerated vertical spacings around section headings.
The current spacing is definitely anomalous.

In order to not re-create the #5960 problem that people may get different looking PDFs if compiling on a current system and simultaneously on an old one not up-to-date, we could also ship a sphinxparskip.sty which would be a clone of current parskip.sty with removal of dependency on LaTeX kernel features requiring its 2018-04-01 release (only a few lines to remove at top of the parskip.sty file).

+1 for that option which is the safest one (although it will override any upstream change to parskip.sty) and makes sure #5960 does not resuscitate. I will wait for advices.

EDIT: attention that parskip v2 requires etoolbox package. It is part in Ubuntu of texlive-latex-recommended which we document as required and on Fedora part of texlive package people probably already require.

@jfbu jfbu added this to the some future version milestone Aug 27, 2024
@AA-Turner AA-Turner merged commit 173838b into sphinx-doc:master Oct 5, 2024
23 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants