singlehtml: deprecate the 'fix_refuris' helper function

jayaddison commented 1 month ago

Feature or Bugfix

Deprecation

Purpose

Deprecates a singlehtml builder helper method that I believe should be redundant since #11970 and #12551 are in place, but that might, perhaps, be re-used by other functionality (extensions / codebases).

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

Follow-up to #11970 and #12551.

Edit: update description: this PR removes calls to the method, so don't imply that this is deprecation of already-unused code.

jayaddison commented 4 weeks ago

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.

jayaddison commented 1 week ago

Our deprecation policy calls for two major releases. Any reason to expidite this one?

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.

sphinx-doc / sphinx