Skip to content

gh-118401: Docs: Use Sphinx short options#118403

Merged
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-short-opt
Apr 29, 2024
Merged

gh-118401: Docs: Use Sphinx short options#118403
hugovk merged 1 commit into
python:mainfrom
hugovk:docs-fix-sphinx-short-opt

Conversation

@hugovk

@hugovk hugovk commented Apr 29, 2024

Copy link
Copy Markdown
Member

On PRs which haven't synced with main yet, they're still installing Sphinx 7.2 instead of 7.3. That's fine.

But when the CI runs, GitHub is using the workflow from main that has the 7.3-only long options, and not the workflow from their own branch that has the 7.2-and-7.3 short options. This is surprising.

Quick fix: they can update their PR branches with main, but this will be disruptive for more PRs.

Better fix: keep short options in the workflow for longer, perhaps until we upgrade Sphinx to 7.4 or 8.0.

@gaogaotiantian

Copy link
Copy Markdown
Member

Yeah I think it would be much less disruptive if we changed this to long options when the old version also supports it.

@hugovk hugovk enabled auto-merge (squash) April 29, 2024 19:24

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

@hugovk hugovk merged commit ee3413c into python:main Apr 29, 2024
@hugovk hugovk deleted the docs-fix-sphinx-short-opt branch April 29, 2024 19:42
@miss-islington-app

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 29, 2024
(cherry picked from commit ee3413c)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app

bedevere-app Bot commented Apr 29, 2024

Copy link
Copy Markdown

GH-118407 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 Apr 29, 2024
hugovk added a commit that referenced this pull request Apr 29, 2024
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants