Skip to content

🐛 Fix singlehtml target uris to be same-document references #11970

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Apr 7, 2024
Merged

🐛 Fix singlehtml target uris to be same-document references #11970

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6bd7de2
Fix singlehtml target uris to be same-document references
eanorige Feb 8, 2024
81f4104
Merge branch 'master' into singlehtml_uri_fix
picnixz Apr 4, 2024
160db8e
Merge branch 'master' into singlehtml_uri_fix
picnixz Apr 5, 2024
c9b140f
update CHANGES.rst
picnixz Apr 5, 2024
8eda4bf
update CHANGES.rst
picnixz Apr 5, 2024
40d9732
Merge branch 'master' into singlehtml_uri_fix
picnixz Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ Bugs fixed
* #12040: HTML Search: Ensure that document titles that are partially-matched by
the user search query are included in search results.
Patch by James Addison.
* #11970: singlehtml builder: make target URIs to be same-document references in
the sense of :rfc:`RFC 3986, §4.4 <3986#section-4.4>`, e.g., ``index.html#foo``
becomes ``#foo``. Patch by eanorige.

Testing
-------
Expand Down
3 changes: 1 addition & 2 deletions sphinx/builders/singlehtml.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@ def get_outdated_docs(self) -> str | list[str]: # type: ignore[override]
def get_target_uri(self, docname: str, typ: str | None = None) -> str:
if docname in self.env.all_docs:
# all references are on the same page...
return self.config.root_doc + self.out_suffix + \
'#document-' + docname
return '#document-' + docname
else:
# chances are this is a html_additional_page
return docname + self.out_suffix
Expand Down