NotificationsYou must be signed in to change notification settings
Fork32k
Star67.2k

Docs HTML: Remove self-closing tags#132220

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

hugovk merged 2 commits intopython:mainfromhugovk:deslash

Apr 7, 2025

Merged

Docs HTML: Remove self-closing tags#132220

hugovk merged 2 commits intopython:mainfromhugovk:deslash

Apr 7, 2025

Conversation

Copy link

Member

hugovk commentedApr 7, 2025•
edited by github-actionsbot
Loading

Self-closing tags (<tag />) do not exist in HTML.
If a trailing/ (slash) character is present in the start tag of an HTML element, HTML parsers ignore that slash character. This is especially important to remember for elements such as<script> or<ul> that do require a closing tag. In these cases, adding a trailing slash in the start tag does not close the element. Instead, the trailing slash is ignored, and the element is treated as open until an explicit closing tag is encountered or until the parser implicitly closes the element based on the HTML structure and parsing rules. For example, in the case of<div/>Some text, browsers interpret this as<div>Some text</div>, treating the slash as ignored and considering the div element to encapsulate the text that follows.

https://developer.mozilla.org/en-US/docs/Glossary/Void_element#self-closing_tags

Let's omit them: they're ignored, could be misleading (give the false impression they do something when they do not) and are ugly (IMO).

📚 Documentation preview 📚:https://cpython-previews--132220.org.readthedocs.build/

Remove self-closing tags

9ae25b5

https://developer.mozilla.org/en-US/docs/Glossary/Void_element\#self-closing_tags

hugovk added the skip issue label

Apr 7, 2025

hugovk requested a review fromAA-Turner as acode owner

April 7, 2025 12:44

bedevere-appbot added the awaiting core review label

Apr 7, 2025

hugovk added the skip news label

Apr 7, 2025

hugovk mentioned this pull request

Apr 7, 2025

gh-130521: Add meta tags for template pages#130523

Merged

hugovk added needs backport to 3.12

only security fixes

needs backport to 3.13bugs and security fixes labels

Apr 7, 2025

merwok approved these changes

Apr 7, 2025

View reviewed changes

bedevere-appbot added awaiting merge and removed awaiting core review labels

Apr 7, 2025

Copy link

Member

picnixz commentedApr 7, 2025

I think we have self-closing tags in Sphinx' writers so we should also fix this upstream.

Remove more trailing slashes

bb98b48

AA-Turner requested a review froma team as acode owner

April 7, 2025 15:14

AA-Turner approved these changes

Apr 7, 2025

View reviewed changes

hugovk merged commitce72457 intopython:main

Apr 7, 2025

24 checks passed

hugovk deleted the deslash branch

April 7, 2025 15:21

Copy link

miss-islington-appbot commentedApr 7, 2025

Thanks@hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

bedevere-appbot removed the awaiting merge label

Apr 7, 2025

Copy link

miss-islington-appbot commentedApr 7, 2025

Sorry,@hugovk, I could not cleanly backport this to3.13 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker ce724571b35f4e79fff1c862fcd9afa4c26b605f 3.13

miss-islington-appbot assignedhugovk

Apr 7, 2025

Copy link

miss-islington-appbot commentedApr 7, 2025

Sorry,@hugovk, I could not cleanly backport this to3.12 due to a conflict.
Please backport usingcherry_picker on command line.

cherry_picker ce724571b35f4e79fff1c862fcd9afa4c26b605f 3.12

hugovk added a commit to hugovk/cpython that referenced this pull request

Apr 7, 2025

[3.13] Docs HTML: Remove self-closing tags (pythonGH-132220)

4167c81

(cherry picked from commitce72457)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

Copy link

bedevere-appbot commentedApr 7, 2025

GH-132228 is a backport of this pull request to the3.13 branch.

bedevere-appbot removed the needs backport to 3.13bugs and security fixes label

Apr 7, 2025

hugovk added a commit to hugovk/cpython that referenced this pull request

Apr 7, 2025

[3.12] Docs HTML: Remove self-closing tags (pythonGH-132220)

f48bb23

(cherry picked from commitce72457)Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

Copy link

bedevere-appbot commentedApr 7, 2025

GH-132229 is a backport of this pull request to the3.12 branch.

bedevere-appbot removed the needs backport to 3.12only security fixes label

Apr 7, 2025

AA-Turner added a commit that referenced this pull request

Apr 7, 2025

[3.13] Docs HTML: Remove self-closing tags (GH-132220) (#132228)

bf5471f

(cherry picked from commitce72457)Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

AA-Turner added a commit that referenced this pull request

Apr 7, 2025

[3.12] Docs HTML: Remove self-closing tags (GH-132220) (#132229)

6c9ece3

(cherry picked from commitce72457)Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

AA-Turner mentioned this pull request

Apr 11, 2025

Account for recent removal of self-closing tagspython/docsbuild-scripts#264

Merged

seehwan pushed a commit to seehwan/cpython that referenced this pull request

Apr 16, 2025

Docs HTML: Remove self-closing tags (python#132220)

e4867be

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>

Copy link

Contributor

m-aciek commentedMay 8, 2025

Change inDoc/tools/templates/layout.html breaks EPUBs. Maybe we should add it only when the builder ishtml?

% uvx epubcheck…FATAL - RSC-016 - Python.epub/c-api/codec.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/c-api/complex.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/c-api/concrete.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/c-api/contextvars.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/c-api/conversion.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/c-api/coro.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/contents.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/copyright.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/glossary.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/license.xhtml:27:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/py-modindex.xhtml:29:5 - Fatal Error while parsing file: The element type "link" must be terminated by the matching end-tag "</link>".FATAL - RSC-016 - Python.epub/download.xhtml:36:5 - Fatal Error while parsing file: The element type "meta" must be terminated by the matching end-tag "</meta>".FATAL - RSC-016 - Python.epub/index.xhtml:35:5 - Fatal Error while parsing file: The element type "meta" must be terminated by the matching end-tag "</meta>".