Skip to content

gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds #136187

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

Jump to bottom
Merged
merged 3 commits into from
Jul 7, 2025
Merged

gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds #136187

merged 3 commits into from
Jul 7, 2025

Conversation

m-aciek
Copy link
Contributor

@m-aciek m-aciek commented Jul 1, 2025 •
edited
Loading

Confirmed locally that it fixes broken EPUB builds.

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

@m-aciek m-aciek requested review from AA-Turner and hugovk as code owners July 1, 2025 20:10
@bedevere-app bedevere-app bot mentioned this pull request Jul 1, 2025
Open
@m-aciek m-aciek mentioned this pull request Jul 1, 2025
Closed
@StanFromIreland
Copy link
Member

StanFromIreland commented Jul 1, 2025 •
edited
Loading

This can get a blurb (NEWS) under Documentation.

@m-aciek m-aciek mentioned this pull request Jul 1, 2025
Open
@hugovk
Copy link
Member

hugovk commented Jul 7, 2025

For future reference, Sphinx inserts this epub tag:

The format and the name of the current builder (html, latex or text) are always set as a tag [4]. To make the distinction between format and name explicit, they are also added with the prefix format_ and builder_, e.g. the epub builder defines the tags html, epub, format_html and builder_epub.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#tags

hugovk
hugovk reviewed Jul 7, 2025
View reviewed changes
hugovk
hugovk approved these changes Jul 7, 2025
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jul 7, 2025
@hugovk
Copy link
Member

hugovk commented Jul 7, 2025

Also needs backporting to the 3.12 branch as https://docs.python.org/3/archives/python-3.13-docs.epub is currently broken:

#132220 (comment)

@hugovk hugovk changed the title gh-136155: Docs: don't add custom OpenGraph protocol meta tags for EPUB builds gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds Jul 7, 2025
@hugovk hugovk merged commit c45da6a into python:main Jul 7, 2025
35 checks passed
@miss-islington-app
Copy link

Thanks @m-aciek for the PR, and @hugovk 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 request Jul 7, 2025
@m-aciek @blurb-it @miss-islington
pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…
65ff40f 
…or HTML builds (pythonGH-136187)

(cherry picked from commit c45da6a)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 7, 2025

GH-136382 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 7, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 7, 2025
@m-aciek @blurb-it @miss-islington
pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…
ec2256a 
…or HTML builds (pythonGH-136187)

(cherry picked from commit c45da6a)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
@miss-islington-app
Copy link

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

cherry_picker c45da6ae16a0bc796e880c9dbcd4f643345b03b7 3.12

@bedevere-app
Copy link

bedevere-app bot commented Jul 7, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 7, 2025
@hugovk
Copy link
Member

hugovk commented Jul 7, 2025

Will confirm main is fixed before merging the backports.

@m-aciek m-aciek deleted the docs/fix-epub-builds branch July 7, 2025 19:58
@m-aciek
Copy link
Contributor Author

m-aciek commented Jul 7, 2025

Will confirm main is fixed before merging the backports.

It looks like we only reduced number of fatal errors from 33 to 8. 👀

@hugovk
Copy link
Member

hugovk commented Jul 8, 2025

Well, that's going in the right direction, so we can merge the backports. And it shows the CI check will be useful 👍

Let's continue in the issue.

hugovk pushed a commit that referenced this pull request Jul 8, 2025
@miss-islington @m-aciek @blurb-it
[3.14] gh-136155: Docs: only add custom OpenGraph protocol meta tags …
3296d9b 
…for HTML builds (GH-136187) (#136382)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request Jul 8, 2025
@miss-islington @m-aciek @blurb-it
[3.13] gh-136155: Docs: only add custom OpenGraph protocol meta tags …
f17be28 
…for HTML builds (GH-136187) (#136383)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Jul 8, 2025
@m-aciek @blurb-it @hugovk
[3.12] pythongh-136155: Docs: only add custom OpenGraph protocol meta…
c9ab6d3 
… tags for HTML builds (pythonGH-136187)

(cherry picked from commit c45da6a)

Co-authored-by: Maciej Olko <maciej.olko@affirm.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jul 8, 2025

GH-136406 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Jul 8, 2025
@m-aciek m-aciek mentioned this pull request Jul 10, 2025
Open
AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025
@m-aciek @blurb-it @AndPuQing
pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…
93b9ae0 
…or HTML builds (python#136187)

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Pranjal095 pushed a commit to Pranjal095/cpython that referenced this pull request Jul 12, 2025
@m-aciek @blurb-it @Pranjal095
pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…
ebda3a4 
…or HTML builds (python#136187)

Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

Assignees

@hugovk hugovk

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@m-aciek @StanFromIreland @hugovk
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy