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.

Sign up for GitHub

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

Jump to bottom

Fix Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output (#9940) #9941

Merged
merged 4 commits into from Dec 11, 2021
Merged

Fix Multi-function declaration in Python domain has cramped vertical spacing in latexpdf output (#9940) #9941

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b230365
Fix Multi-function declaration in Python domain has cramped spacing
jfbu Dec 5, 2021
091c2de
Update CHANGES
jfbu Dec 5, 2021
b902d85
Update CHANGES for #9941
jfbu Dec 10, 2021
4c5aa2a
Merge branch '4.x' into 9940_pymultifunction_latex
jfbu Dec 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES
View file
Open in desktop
Expand Up @@ -39,6 +39,8 @@ Bugs fixed
* #9925: LaTeX: prohibit also with ``'xelatex'`` line splitting at dashes of
inline and parsed literals
* #9944: LaTeX: extra vertical whitespace for some nested declarations
* #9940: Multi-function declaration in Python domain has cramped vertical
jfbu marked this conversation as resolved.
Show resolved Hide resolved
spacing in latexpdf output

Testing
--------
Expand Down
33 changes: 24 additions & 9 deletions sphinx/texinputs/sphinxlatexobjects.sty
View file
Open in desktop
@@ -1,7 +1,7 @@
%% MODULE RELEASE DATA AND OBJECT DESCRIPTIONS
%
% change this info string if making any custom modification
\ProvidesFile{sphinxlatexobjects.sty}[2021/01/27 documentation environments]
\ProvidesFile{sphinxlatexobjects.sty}[2021/12/05 documentation environments]

% Provides support for this output mark-up from Sphinx latex writer:
%
Expand Down Expand Up @@ -91,21 +91,36 @@
% \relax only ends its "dimen" part
\py@argswidth=\dimexpr\linewidth+\labelwidth\relax\relax
\item[{\parbox[t]{\py@argswidth}{\raggedright #1\strut}}]
% contrarily to \pysiglinewithargsret, we do not do this:
% \leavevmode\par\nobreak\vskip-\parskip\prevdepth\dp\strutbox
% which would give exact vertical spacing if item parbox is multi-line,
% as it affects negatively more common situation of \pysigline
% used twice or more in a row for labels sharing common description,
% due to bad interaction with the \phantomsection in the mark-up
\futurelet\sphinx@token\pysigline@preparevspace@i
}
\newcommand{\pysiglinewithargsret}[3]{%
\settowidth{\py@argswidth}{#1\sphinxcode{(}}%
\py@argswidth=\dimexpr\linewidth+\labelwidth-\py@argswidth\relax\relax
\item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]
\item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}\strut}]
\futurelet\sphinx@token\pysigline@preparevspace@i
}
\def\pysigline@preparevspace@i{%
\ifx\sphinx@token\@sptoken
\expandafter\pysigline@preparevspace@again
\else\expandafter\pysigline@preparevspace@ii
\fi
}
\@firstofone{\def\pysigline@preparevspace@again} {\futurelet\sphinx@token\pysigline@preparevspace@i}
\long\def\pysigline@preparevspace@ii#1{%
\ifx\sphinx@token\bgroup\expandafter\@firstoftwo
\else
\ifx\sphinx@token\phantomsection
\else
% this strange incantation is because at its root LaTeX in fact did not
% imagine a multi-line label, it is always wrapped in a horizontal box at core
% LaTeX level and we have to find tricks to get correct interline distances.
\leavevmode\par\nobreak\vskip-\parskip\prevdepth\dp\strutbox}
% It interacts badly with a follow-up \phantomsection hence the test above
\leavevmode\par\nobreak\vskip-\parskip\prevdepth\dp\strutbox
\fi
\expandafter\@secondoftwo
\fi
{{#1}}{#1}%
}
\newcommand{\pysigstartmultiline}{%
\def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}%
\edef\pysigstopmultiline
Expand Down