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

singlehtml: deprecate 'fix_refuris' helper function #13037

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Oct 18, 2024

Feature or Bugfix

  • Deprecation

Purpose

Detail

  • Deprecates the sphinx.builders.singlehtml.SingleFileHTMLBuilder.fix_refuris method, 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.

Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remember to add new deprecations to doc/extdev/deprecated.rst.

A

@jayaddison
Copy link
Contributor Author

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 singlehtml projects) on it next week before re-requesting approval/merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants