gh-136155: Docs: only add custom OpenGraph protocol meta tags for HTML builds by m-aciek · Pull Request #136187 · python/cpython

m-aciek · 2025-07-01T20:10:17Z

Confirmed locally that it fixes broken EPUB builds.

Issue: Docs: EPUB builds are broken #136155

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

…for EPUB builds

StanFromIreland · 2025-07-01T20:21:24Z

This can get a blurb (NEWS) under Documentation.

hugovk · 2025-07-07T12:07:11Z

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

Doc/conf.py

hugovk

Thank you!

hugovk · 2025-07-07T13:28:49Z

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)

miss-islington-app · 2025-07-07T13:29:31Z

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.
🐍🍒⛏🤖

…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 · 2025-07-07T13:29:39Z

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

…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 · 2025-07-07T13:29:43Z

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 · 2025-07-07T13:29:44Z

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

hugovk · 2025-07-07T13:45:33Z

Will confirm main is fixed before merging the backports.

m-aciek · 2025-07-07T19:59:40Z

Will confirm main is fixed before merging the backports.

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

hugovk · 2025-07-08T07:00:20Z

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.

…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>

…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>

… 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 · 2025-07-08T07:07:52Z

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

…or HTML builds (python#136187) Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>

…a tags for HTML builds (python#136187)" This reverts commit c45da6a.

…or HTML builds (python#136187) Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>

pythongh-136155: Docs: don't add custom OpenGraph protocol meta tags …

716eece

…for EPUB builds

m-aciek requested review from AA-Turner and hugovk as code owners July 1, 2025 20:10

bedevere-app bot added the awaiting review label Jul 1, 2025

bedevere-app bot mentioned this pull request Jul 1, 2025

Docs: EPUB builds are broken #136155

Closed

m-aciek mentioned this pull request Jul 1, 2025

Docs EPUB: fix meta tags connected with Open Graph #134071

Closed

📜🤖 Added by blurb_it.

f8240ce

m-aciek mentioned this pull request Jul 1, 2025

gh-136155: Docs: check for EPUB fatal errors in CI #134074

Merged

hugovk reviewed Jul 7, 2025

View reviewed changes

Doc/conf.py Outdated Show resolved Hide resolved

Use positive filtering to add custom tags only to HTML build

f1fefda

hugovk approved these changes Jul 7, 2025

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Jul 7, 2025

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 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 merged commit c45da6a into python:main Jul 7, 2025
35 checks passed

bedevere-app bot removed the awaiting merge label Jul 7, 2025

bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jul 7, 2025

miss-islington-app bot assigned hugovk Jul 7, 2025

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jul 7, 2025

m-aciek deleted the docs/fix-epub-builds branch July 7, 2025 19:58

bedevere-app bot removed the needs backport to 3.12 only security fixes label Jul 8, 2025

m-aciek mentioned this pull request Jul 10, 2025

Custom tags and EPUB builder sphinx-doc/sphinxext-opengraph#136

Closed

AndPuQing pushed a commit to AndPuQing/cpython that referenced this pull request Jul 11, 2025

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

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>

picnixz pushed a commit to picnixz/cpython that referenced this pull request Jul 13, 2025

pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…

c84c06f

…or HTML builds (python#136187) Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>

taegyunkim pushed a commit to taegyunkim/cpython that referenced this pull request Aug 4, 2025

pythongh-136155: Docs: only add custom OpenGraph protocol meta tags f…

2f189e3

…or HTML builds (python#136187) Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>

AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Aug 5, 2025

Revert "pythongh-136155: Docs: only add custom OpenGraph protocol met…

d8bb086

…a tags for HTML builds (python#136187)" This reverts commit c45da6a.

Uh oh!

Conversation

m-aciek commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

StanFromIreland commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Jul 7, 2025

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

hugovk commented Jul 7, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Jul 7, 2025

Uh oh!

bedevere-app bot commented Jul 7, 2025

Uh oh!

miss-islington-app bot commented Jul 7, 2025

Uh oh!

bedevere-app bot commented Jul 7, 2025

Uh oh!

hugovk commented Jul 7, 2025

Uh oh!

m-aciek commented Jul 7, 2025

Uh oh!

hugovk commented Jul 8, 2025

Uh oh!

bedevere-app bot commented Jul 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

m-aciek commented Jul 1, 2025 •

edited

Loading

StanFromIreland commented Jul 1, 2025 •

edited

Loading