LaTeX: fix #12380 #12382
Merged
LaTeX: fix #12380 #12382
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The problem was there ever since sphinx-doc#10191 added the footnote feature to indicate the page number where footnote ends up printed, if not on same page. It is complicated to add a test for this change because the patch only modifies how a certain custom LaTeX macro behaves so one has to check PDF output which is bothersome. But it got tested with a number of sources already used for sphinx-doc#10191 (one such test showed already the sphinx-doc#12380 problem, but got overlooked at that time). MEMO: the feature works only when Sphinx uses `\sphinxfootnotemark` mark-up in LaTeX output; sometimes it may use rather a `footnote` environment, then the mechanism is not activated. This may happen for example inside a cell of a long table, it can be that `Page N` will not be added, because the `\sphinxfootnotemark` which does that is not activated, although the footnote, which gets printed after the long table ends, is on a different page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Fix #12380 (LaTeX footnotes)
The problem was there ever since #10191 added the footnote feature to
indicate the page number where footnote ends up printed, if not on same
page.
It is complicated to add a test for this change because the patch only
modifies how a certain custom LaTeX macro behaves so one has to check
PDF output which is bothersome. But it got tested with a number of
sources already used for #10191 (one such test showed already the #12380
problem, but got overlooked at that time).
MEMO: the feature works only when Sphinx uses
\sphinxfootnotemarkmark-up in LaTeX output; sometimes it may use rather a
footnoteenvironment, then the mechanism is not activated. This may happen for
example inside a cell of a long table, it can be that
Page Nwill notbe added, because the
\sphinxfootnotemarkwhich does that is notactivated, although the footnote, which gets printed after the long
table ends, is on a different page.
Feature or Bugfix
Relates