X Tutup
Skip to content

GH-136155: Use sphinxext-opengraph v0.12.0#137393

Merged
AA-Turner merged 5 commits intopython:mainfrom
AA-Turner:docs/opengraph-0.12
Aug 5, 2025
Merged

GH-136155: Use sphinxext-opengraph v0.12.0#137393
AA-Turner merged 5 commits intopython:mainfrom
AA-Turner:docs/opengraph-0.12

Conversation

@AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Aug 4, 2025 •
edited by github-actions bot
Loading

@AA-Turner AA-Turner requested a review from hugovk as a code owner August 4, 2025 21:56
@AA-Turner AA-Turner added the docs Documentation in the Doc dir label Aug 4, 2025
@AA-Turner AA-Turner added skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 4, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 4, 2025
@bedevere-app bedevere-app bot mentioned this pull request Aug 4, 2025
Closed
@AA-Turner
Copy link
Member Author

AA-Turner commented Aug 4, 2025

cc @m-aciek @hugovk

@AA-Turner
Copy link
Member Author

AA-Turner commented Aug 4, 2025

sphinxext-opengraph v0.12.0 unconditionally skips when it detects the EPUB builder, which should at least not make things worse.

A

@AA-Turner
Copy link
Member Author

AA-Turner commented Aug 4, 2025

I think we should also revert c45da6a in this PR.

@hugovk
Copy link
Member

hugovk commented Aug 5, 2025

I think we should also revert c45da6a in this PR.

Can do, the guard in sphinxext-opengraph helps.

Although does it make a difference to only include it for html, or exclude it from things like latex and texinfo?

hugovk
hugovk approved these changes Aug 5, 2025
View reviewed changes
Doc/requirements.txt
blurb

sphinxext-opengraph~=0.11.0
sphinxext-opengraph~=0.12.0
Copy link
Member

@hugovk hugovk Aug 5, 2025

Choose a reason for hiding this comment

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

Does sphinxext-opengraph use SemVer?

If so, it's definitely used in production, time for 1.0.0 🚀

https://semver.org/#how-do-i-know-when-to-release-100

@AA-Turner
Copy link
Member Author

AA-Turner commented Aug 5, 2025

Although does it make a difference to only include it for html, or exclude it from things like latex and texinfo?

The event it uses (html_page_context) is only emitted for HTML-based builders, EPUB is an oddity in that it is not really HTML but a variant of XHTML.

@hugovk
Copy link
Member

hugovk commented Aug 5, 2025 •
edited
Loading

Updating branch because CI didn't fully run, perhaps due to https://www.githubstatus.com/incidents/6swp0zf7lk8h.

@AA-Turner AA-Turner merged commit 39bd7c3 into python:main Aug 5, 2025
25 checks passed
@AA-Turner AA-Turner deleted the docs/opengraph-0.12 branch August 5, 2025 20:14
@miss-islington-app
Copy link

miss-islington-app bot commented Aug 5, 2025

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 5, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2025
@AA-Turner @miss-islington
pythonGH-136155: Use sphinxext-opengraph v0.12.0 (pythonGH-137393)
3081072 
(cherry picked from commit 39bd7c3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2025
@AA-Turner @miss-islington
pythonGH-136155: Use sphinxext-opengraph v0.12.0 (pythonGH-137393)
14993d7 
(cherry picked from commit 39bd7c3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Aug 5, 2025

GH-137431 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 Aug 5, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 5, 2025

GH-137432 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 Aug 5, 2025
AA-Turner added a commit that referenced this pull request Aug 5, 2025
@miss-islington @AA-Turner
[3.13] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) (#1…
c4c554d 
…37432)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request Aug 5, 2025
@miss-islington @AA-Turner
[3.14] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) (#1…
3a1e582 
…37431)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit to hugovk/cpython that referenced this pull request Aug 8, 2025
@AA-Turner
pythonGH-136155: Use sphinxext-opengraph v0.12.0 (python#137393)
ff315b7
@AA-Turner AA-Turner mentioned this pull request Aug 8, 2025
Merged
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@AA-Turner @Agent-Hellboy
pythonGH-136155: Use sphinxext-opengraph v0.12.0 (python#137393)
24c464f
kumaraditya303 pushed a commit to miss-islington/cpython that referenced this pull request Sep 9, 2025
@miss-islington @AA-Turner @kumaraditya303
[3.14] pythonGH-136155: Use sphinxext-opengraph v0.12.0 (pythonGH…
10e1e3c 
…-137393) (python#137431)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk
Copy link
Member

hugovk commented Sep 10, 2025

Some of this was backported to 3.12 in #136406, but we're still getting EPUB errors for 3.12: #136406 (comment)

Let's backport the rest.

@hugovk hugovk added the needs backport to 3.12 only security fixes label Sep 10, 2025
@miss-islington-app
Copy link

miss-islington-app bot commented Sep 10, 2025

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Sep 10, 2025

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

cherry_picker 39bd7c3156b00dda85ea09dffdde3e3536f37a55 3.12

hugovk pushed a commit to hugovk/cpython that referenced this pull request Sep 10, 2025
@AA-Turner @hugovk
[3.12] pythonGH-136155: Use sphinxext-opengraph v0.12.0 (pythonGH…
2239242 
…-137393)

(cherry picked from commit 39bd7c3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 10, 2025

GH-138741 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 Sep 10, 2025
hugovk added a commit that referenced this pull request Sep 24, 2025
@hugovk @AA-Turner
[3.12] GH-136155: Use sphinxext-opengraph v0.12.0 (GH-137393) (#1…
71c84fa 
…38741)

(cherry picked from commit 39bd7c3)

Co-authored-by: Adam Turner <9087854+AA-Turner@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

Assignees

@AA-Turner AA-Turner

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AA-Turner @hugovk
X Tutup