GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-118401: Docs: Use Sphinx short options by hugovk · Pull Request #118403 · python/cpython

Conversation

@hugovk

@hugovk hugovk commented Apr 29, 2024 •
edited by bedevere-app Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

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.

  • Issue: Doc workflow is failing due to a missing file 'Doc/sphinx-warnings.txt' #118401

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@hugovk
Docs: Use Sphinx short options
5d801a2
@hugovk
hugovk requested a review from ezio-melotti as a code owner April 29, 2024 19:08
@bedevere-app bedevere-app Bot mentioned this pull request Apr 29, 2024
Doc workflow is failing due to a missing file 'Doc/sphinx-warnings.txt' #118401
Closed
@hugovk hugovk added the needs backport to 3.12 only security fixes label Apr 29, 2024
@bedevere-app bedevere-app Bot added the awaiting core review label Apr 29, 2024
@hugovk hugovk added skip news docs Documentation in the Doc dir labels Apr 29, 2024
@gaogaotiantian

gaogaotiantian commented Apr 29, 2024

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 reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
gaogaotiantian
gaogaotiantian approved these changes Apr 29, 2024
View reviewed changes
@hugovk
hugovk enabled auto-merge (squash) April 29, 2024 19:24
serhiy-storchaka
serhiy-storchaka approved these changes Apr 29, 2024
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

👍

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels Apr 29, 2024
@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

miss-islington-app Bot commented Apr 29, 2024

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label Apr 29, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 29, 2024
@hugovk @miss-islington
pythongh-118401: Docs: Use Sphinx short options (pythonGH-118403)
3e610e3 
(cherry picked from commit ee3413c)

Co-authored-by: Hugo van Kemenade <[email protected]>
@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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
@miss-islington @hugovk
[3.12] gh-118401: Docs: Use Sphinx short options (GH-118403) (#118407)
e990594 
Co-authored-by: Hugo van Kemenade <[email protected]>
@AA-Turner AA-Turner mentioned this pull request Jan 20, 2025
GH-125722: Use long options for Sphinx #129039
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes
@gaogaotiantian gaogaotiantian gaogaotiantian approved these changes
@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti ezio-melotti is a code owner

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@hugovk @gaogaotiantian @serhiy-storchaka
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.