Docs: remove link elements in builders other than HTML #133720
Merged
+4
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change fixes EPUBs
merwok
approved these changes
May 9, 2025
This comment was marked as outdated.
This comment was marked as outdated.
|
We have three conditionals in a row (extra whitespace for clarity): {% if builder == "html" and enable_analytics %}
<script defer data-domain="docs.python.org" src="https://analytics.python.org/js/script.outbound-links.js"></script>
{% endif %}
{% if builder == "html" %}<link rel="canonical" href="https://docs.python.org/3/{{pagename}}.html">{% endif %}
{% if builder != "htmlhelp" %}
{% if pagename == 'whatsnew/changelog' and not embedded %}
<script type="text/javascript" src="{{ pathto('_static/changelog_search.js', 1) }}"></script>{% endif %}
{% endif %}Should that last If so, shall we factor that check out? Something along the lines of: {% if builder == "html" %}
{% if enable_analytics %}
<script defer data-domain="docs.python.org" src="https://analytics.python.org/js/script.outbound-links.js"></script>
{% endif %}
<link rel="canonical" href="https://docs.python.org/3/{{pagename}}.html">
{% if pagename == 'whatsnew/changelog' and not embedded %}
<script type="text/javascript" src="{{ pathto('_static/changelog_search.js', 1) }}"></script>{% endif %}
{% endif %} |
|
@Yhg1s this fixes a bug in docs epub build; would it be acceptable for backport to 3.12 ? |
|
Yeah, backporting to 3.12 is fine. |
merwok
approved these changes
May 13, 2025
hugovk
approved these changes
May 14, 2025
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 14, 2025
Fixes epub build (cherry picked from commit 0afbd4e42ac28240b484cabe1710fdb6c572fb1f) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
|
GH-134005 is a backport of this pull request to the 3.14 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 14, 2025
Fixes epub build (cherry picked from commit 0afbd4e) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 14, 2025
Fixes epub build (cherry picked from commit 0afbd4e) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
|
GH-134006 is a backport of this pull request to the 3.13 branch. |
|
GH-134007 is a backport of this pull request to the 3.12 branch. |
This comment was marked as spam.
This comment was marked as spam.
hugovk
pushed a commit
that referenced
this pull request
May 14, 2025
) (#134005) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
hugovk
pushed a commit
that referenced
this pull request
May 14, 2025
) (#134006) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
hugovk
pushed a commit
that referenced
this pull request
May 14, 2025
) (#134007) Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up for #132220 (#132220 (comment)). This change fixes EPUB builds.
epubcheckafter this change results in 25 fewer errors. Could we please backport it for supported versions?Before:
After:
📚 Documentation preview 📚: https://cpython-previews--133720.org.readthedocs.build/