Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Docs: remove link elements in builders other than HTML#133720

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

Merged
merwok merged 2 commits intopython:mainfromm-aciek:doc-epub-fix-head
May 14, 2025

Conversation

m-aciek
Copy link
Contributor

@m-aciekm-aciek commentedMay 8, 2025•
edited
Loading

Follow-up for#132220 (#132220 (comment)). This change fixes EPUB builds.epubcheck after this change results in 25 fewer errors. Could we please backport it for supported versions?

Before:

% uvx epubcheck2>&1>/dev/null| grep'FATAL'FATAL - RSC-016 - Python.epub/about.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/bugs.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/abstract.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/allocation.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/apiabiversion.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/arg.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/bool.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/buffer.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/bytearray.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/bytes.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/call.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/capsule.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/cell.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/code.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/codec.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/complex.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/concrete.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/c-api/contextvars.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/contents.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/copyright.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/download.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/glossary.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/index.xhtml:26:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/license.xhtml:27:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".FATAL - RSC-016 - Python.epub/py-modindex.xhtml:29:5 - Fatal Errorwhile parsing file: The elementtype"link" must be terminated by the matching end-tag"</link>".
Zrzut ekranu 2025-05-9 o 01 11 57

After:

Zrzut ekranu 2025-05-9 o 03 34 10

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

@merwokmerwok added needs backport to 3.13bugs and security fixes needs backport to 3.14bugs and security fixes labelsMay 9, 2025
@merwok

This comment was marked as outdated.

@hugovk
Copy link
Member

We have three conditionals in a row (extra whitespace for clarity):

    {% if builder == "html" and enable_analytics %}<scriptdeferdata-domain="docs.python.org"src="https://analytics.python.org/js/script.outbound-links.js"></script>    {% endif %}    {% if builder == "html" %}<linkrel="canonical"href="https://docs.python.org/3/{{pagename}}.html">{% endif %}    {% if builder != "htmlhelp" %}      {% if pagename == 'whatsnew/changelog' and not embedded %}<scripttype="text/javascript"src="{{ pathto('_static/changelog_search.js', 1) }}"></script>{% endif %}    {% endif %}

Should that lastif builder != "htmlhelp" also beif builder == "html"?

If so, shall we factor that check out? Something along the lines of:

    {% if builder == "html" %}      {% if enable_analytics %}<scriptdeferdata-domain="docs.python.org"src="https://analytics.python.org/js/script.outbound-links.js"></script>      {% endif %}<linkrel="canonical"href="https://docs.python.org/3/{{pagename}}.html">       {% if pagename == 'whatsnew/changelog' and not embedded %}<scripttype="text/javascript"src="{{ pathto('_static/changelog_search.js', 1) }}"></script>{% endif %}    {% endif %}
m-aciek reacted with thumbs up emoji

@merwok
Copy link
Member

@Yhg1s this fixes a bug in docs epub build; would it be acceptable for backport to 3.12 ?

@Yhg1s
Copy link
Member

Yeah, backporting to 3.12 is fine.

merwok reacted with thumbs up emojim-aciek reacted with hooray emoji

@merwokmerwok added the needs backport to 3.12only security fixes labelMay 13, 2025
@merwokmerwok merged commit0afbd4e intopython:mainMay 14, 2025
24 checks passed
@miss-islington-app
Copy link

Thanks@m-aciek for the PR, and@merwok for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 14, 2025
Fixes epub build(cherry picked from commit0afbd4e)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
@bedevere-app
Copy link

GH-134005 is a backport of this pull request to the3.14 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 14, 2025
Fixes epub build(cherry picked from commit0afbd4e)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
@bedevere-appbedevere-appbot removed the needs backport to 3.14bugs and security fixes labelMay 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 14, 2025
Fixes epub build(cherry picked from commit0afbd4e)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelMay 14, 2025
@bedevere-app
Copy link

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

@bedevere-appbedevere-appbot removed the needs backport to 3.12only security fixes labelMay 14, 2025
hugovk pushed a commit that referenced this pull requestMay 14, 2025
) (#134005)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
hugovk pushed a commit that referenced this pull requestMay 14, 2025
) (#134006)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
hugovk pushed a commit that referenced this pull requestMay 14, 2025
) (#134007)Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
@pythonpython deleted a commentMay 15, 2025
@m-aciekm-aciek deleted the doc-epub-fix-head branchMay 15, 2025 21:32
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@merwokmerwokmerwok approved these changes

@hugovkhugovkhugovk approved these changes

@AA-TurnerAA-TurnerAwaiting requested review from AA-TurnerAA-Turner is a code owner

Assignees
No one assigned
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

5 participants
@m-aciek@merwok@hugovk@Yhg1s@ZeroIntensity
[8]ページ先頭
©2009-2025 Movatter.jp