Skip to content

Docs: Move inline JavaScript to own file to reduce duplication - #119541

Merged
hugovk merged 5 commits into
python:mainfrom
hugovk:rtd-switcher
May 27, 2024
Merged

Docs: Move inline JavaScript to own file to reduce duplication#119541
hugovk merged 5 commits into
python:mainfrom
hugovk:rtd-switcher

Conversation

@hugovk

@hugovkhugovk commented May 25, 2024•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Follow on from #116966.

Move the language/version switcher JavaScript from the layout.html template, which meant it was included in the header of every page, and into its own JavaScript file to reduce duplication.

This reduces the size of the entire docs HTML (Doc/build/html) from 69.7 MB to 68.2 MB.

cc @humitos

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

@hugovkhugovk added docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes labels May 25, 2024
Wulian233
Wulian233 reviewed May 25, 2024
View reviewed changes

@Wulian233Wulian233 left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My PR added 3.14 in layout.html which conflicts with the change of this PR

Comment threadDoc/tools/static/rtd_switcher.js
@Wulian233Wulian233 mentioned this pull request May 25, 2024
Merged
humitos
humitos approved these changes May 27, 2024
View reviewed changes

@humitoshumitos left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR makes sense and looks good to me! 👍🏼

@hugovk
hugovk enabled auto-merge (squash) May 27, 2024 14:34
@hugovk

hugovk commented May 27, 2024

Copy link
Copy Markdown
MemberAuthor

PR #119607 will fix the doctest.

@hugovk
hugovk merged commit eea26c4 into python:mainMay 27, 2024
@hugovk
hugovk deleted the rtd-switcher branch May 27, 2024 18:04
@miss-islington-app

miss-islington-appBot commented May 27, 2024

Copy link
Copy Markdown

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

@miss-islington-app

miss-islington-appBot commented May 27, 2024

Copy link
Copy Markdown

Sorry, @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker eea26c4a731ff9547d48a6761b209fee3f2f84df 3.13

hugovk added a commit to hugovk/cpython that referenced this pull request May 27, 2024
@hugovk
[3.13] Docs: Move inline JavaScript to own file to reduce duplication (…
35f8052
…pythonGH-119541)
(cherry picked from commit eea26c4)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented May 27, 2024

Copy link
Copy Markdown

GH-119630 is a backport of this pull request to the 3.13 branch.

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label May 27, 2024
hugovk added a commit that referenced this pull request May 27, 2024
@hugovk
[3.13] Docs: Move inline JavaScript to own file to reduce duplication (…
0a4a318
…GH-119541) (#119630)
@JelleZijlstraJelleZijlstra mentioned this pull request May 28, 2024
Closed
@hugovkhugovk added the needs backport to 3.12 only security fixes label Jun 16, 2024
@miss-islington-app

miss-islington-appBot commented Jun 16, 2024

Copy link
Copy Markdown

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington-app

miss-islington-appBot commented Jun 16, 2024

Copy link
Copy Markdown

Sorry, @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker eea26c4a731ff9547d48a6761b209fee3f2f84df 3.12

@hugovk

hugovk commented Jun 16, 2024

Copy link
Copy Markdown
MemberAuthor

I'll include this 3.12 backport in the #120348 backport.

@hugovkhugovk removed the needs backport to 3.12 only security fixes label Jun 16, 2024
@hugovkhugovk mentioned this pull request Jun 16, 2024
Merged
@humitoshumitos mentioned this pull request Jul 16, 2024
Open
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@hugovk@estyxx
Docs: Move inline JavaScript to own file to reduce duplication (pytho…
3a0f3c4
…n#119541)
@humitoshumitos mentioned this pull request Jul 23, 2024
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@Wulian233Wulian233Wulian233 left review comments
@humitoshumitoshumitos approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@hugovkhugovk

Labels

docsDocumentation in the Doc dirskip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@hugovk@humitos@Wulian233