LaTeX: revisit and trim visit_target() #13616
Open
+6
−24
Conversation
This file contains hidden or 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
Refs: sphinx-doc#13609, sphinx-doc#11093 (sphinx-doc#11333), sphinx-doc#6026 (sphinx-doc#6051). - Fix misnomer in test-latex-labels/index.rst text. Refs: sphinx-doc#13609 (comment) - Patch writers/latex.py as per the proposal at end of: sphinx-doc#13609 (comment) - Update test_latex_build.py::test_latex_labels to detect non desired extra label in LaTeX output. Nota bene: this commit does not revert "Tests: update LaTeX label test expectations from Docutils r10151 (sphinx-doc#13610)" (commit 68d5610) as it is still necessary for compatibility with both Docutils 0.21.2 and Docutils HEAD at their r10151.
jfbu
commented
Jun 5, 2025
| # See: https://github.com/sphinx-doc/sphinx/issues/5948 | ||
| assert result.count(r'\label{\detokenize{index:section1}}') == 1 | ||
| # https://github.com/sphinx-doc/sphinx/issues/13609 | ||
| assert r'\phantomsection\label{\detokenize{index:id' not in result |
There was a problem hiding this comment.
All other LaTeX labels (apart from \phantomsection\label{\detokenize{index::doc}} one sees at start of document body do not use \phantomsection because they follow either a \section/\chapter (et al.) or a \caption and Sphinx LaTeX writer then does not inject unneeded \phantomsection. The named hyperlink reference with embedded alias on the other hand caused with Docutils HEAD at r10151 or later an extra \phantomsection\label which this detects.
|
The patch looks good to me to solve the test output issue. |
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.
Refs: #13609, #11093 (#11333), #6026 (#6051).
Fix misnomer in test-latex-labels/index.rst text.
Refs: Tests: change-in-output with docutils r10151 (0.22-rc) #13609 (comment)
Patch writers/latex.py as per the proposal at end of: Tests: change-in-output with docutils r10151 (0.22-rc) #13609 (comment)
Update test_latex_build.py::test_latex_labels to detect non desired extra label in LaTeX output.
Nota bene: this commit does not revert "Tests: update LaTeX label test expectations from Docutils r10151 (#13610)" (commit 68d5610) as it is still necessary for compatibility with both Docutils 0.21.2 and Docutils HEAD at their r10151.