singlehtml: deprecate the 'fix_refuris' helper function #13037
Merged
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
AA-Turner
requested changes
Oct 18, 2024
…-uri-resolution Conflicts: sphinx/builders/singlehtml.py
|
Although I'm fairly keen to merge this, and think it should be safe -- maybe I'll take one more self-review pass (and/or try some builds of external |
AA-Turner
reviewed
Nov 13, 2024
Nope, this can wait until Sphinx 10 - oddly I think I configured that originally; I can't remember why I reset that to Sphinx 9. |
Co-authored-by: Adam Turner <[email protected]>
AA-Turner
approved these changes
Nov 13, 2024
AA-Turner
changed the title
jayaddison
deleted the
pr-11970-followup/fixup-cleanup-singlehtml-uri-resolution
branch
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.
Feature or Bugfix
Purpose
singlehtmlbuilder helper method that I believe should be redundant since 🐛 Fix singlehtml target uris to be same-document references #11970 and singlehtml: Use same-document hyperlinks for internal project references #12551 are in place, but that might, perhaps, be re-used by other functionality (extensions / codebases).Detail
sphinx.builders.singlehtml.SingleFileHTMLBuilder.fix_refurismethod, and adds a warning noting that it's planned for removal in Sphinx 9 (the next major version).Relates
Edit: update description: this PR removes calls to the method, so don't imply that this is deprecation of already-unused code.