Skip to content

Revert "singlehtml: deprecate the 'fix_refuris' helper function (#13037)"#14241

Open
jayaddison wants to merge 4 commits intosphinx-doc:masterfrom
jayaddison:issue-14221/singlehtml-restore-fix-refuris
Open

Revert "singlehtml: deprecate the 'fix_refuris' helper function (#13037)"#14241
jayaddison wants to merge 4 commits intosphinx-doc:masterfrom
jayaddison:issue-14221/singlehtml-restore-fix-refuris

Conversation

@jayaddison
Copy link
Contributor

Purpose

As reported in #14221, the fix_refuris method does appear to prevent duplicate fragment delimiters (the # character) from appearing in the hyperlinks output by the singlehtml builder.

In my opinion we should still consider fix_refuris deprecated -- I'd still like to remove it, since it seems like an unnecessary post-processing of the documents; but additional investigation is required to confirm what it does and whether a better alternative mechanism can be found.

References

Specifically, check for duplication of the HTML anchor fragment
delimiter character (`#`).

Co-authored-by: @etrian-dev
…nx-doc#13037)"

This reverts commit c93723b.

Conflicts:
	CHANGES.rst
	doc/extdev/deprecated.rst
	sphinx/builders/singlehtml.py
@jayaddison
Copy link
Contributor Author

Self-quoting:

In my opinion we should still consider fix_refuris deprecated -- I'd still like to remove it, since it seems like an unnecessary post-processing of the documents; but additional investigation is required to confirm what it does and whether a better alternative mechanism can be found.

Please refer to this comment for the results of this investigation: #14221 (comment)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect HTML anchors generated by singlehtml builder

1 participant