Skip to content

GH-121970: Extract misc_news into a new extension - #129577

Merged
AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:docs/miscnews
Feb 2, 2025
Merged

GH-121970: Extract misc_news into a new extension#129577
AA-Turner merged 3 commits into
python:mainfrom
AA-Turner:docs/miscnews

Conversation

@AA-Turner

@AA-TurnerAA-Turner commented Feb 2, 2025•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

This removes the PY_MISC_NEWS_DIR environment variable, which was only set/used in make.bat. I've synchronised it with the Makefile, where we always use build/.

I considered removing the relative path handling, and changing the file argument of the .. miscnews:: directive to be relative to the Sphinx confdir (i.e. changing to .. miscnews:: build/NEWS), which would somewhat simplify things, but that could be a follow-up.

A

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

@AA-TurnerAA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 2, 2025
@bedevere-appbedevere-appBot mentioned this pull request Feb 2, 2025
Open
picnixz
picnixz reviewed Feb 2, 2025
View reviewed changes

@picnixzpicnixz 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.

Some comments/questions

Comment threadDoc/tools/extensions/misc_news.py Outdated
Comment threadDoc/tools/extensions/misc_news.py Outdated
Comment threadDoc/tools/extensions/misc_news.py Outdated
picnixz
picnixz approved these changes Feb 2, 2025
View reviewed changes

@picnixzpicnixz 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.

Looks good. By the way, for what reason are we changing the "what's new in ...?" text ?

@AA-Turner

AA-Turner commented Feb 2, 2025

Copy link
Copy Markdown
MemberAuthor

(?im) is the same as re.I | re.M: https://docs.python.org/3/library/re.html#index-16

@picnixz

picnixz commented Feb 2, 2025

Copy link
Copy Markdown
Member

Ah no, I meant: Why is the "What's new in ..." sentences not correct? Namely why are we modifying these parts of the text?

@AA-Turner

AA-Turner commented Feb 2, 2025

Copy link
Copy Markdown
MemberAuthor

Blurb outputs "What's New in " before each heading, which we strip for the rendered changelog. Perhaps we should modify Blurb not to do so.

@AA-TurnerAA-Turner mentioned this pull request Feb 2, 2025
Open
@AA-Turner
AA-Turner merged commit ae47888 into python:mainFeb 2, 2025
@miss-islington-app

miss-islington-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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

@AA-Turner
AA-Turner deleted the docs/miscnews branch February 2, 2025 16:17
@miss-islington-app

miss-islington-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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

cherry_picker ae4788809d674f8e27faef2678953be8cf67d4a3 3.13

@miss-islington-app

miss-islington-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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 ae4788809d674f8e27faef2678953be8cf67d4a3 3.12

@bedevere-app

bedevere-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.13 bugs and security fixes label Feb 2, 2025
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Feb 2, 2025
@AA-Turner
[3.13]pythonGH-121970: Extractmisc_newsinto a new extension (p…
6cd489d
…ythonGH-129577)
(cherry picked from commit ae47888)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit to AA-Turner/cpython that referenced this pull request Feb 2, 2025
@AA-Turner
pythonGH-121970: Extractmisc_newsinto a new extension (python#1…
4c343cd
…29577)
(cherry picked from commit ae47888)
@bedevere-app

bedevere-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot removed the needs backport to 3.12 only security fixes label Feb 2, 2025
@bedevere-app

bedevere-appBot commented Feb 2, 2025

Copy link
Copy Markdown

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

AA-Turner added a commit that referenced this pull request Feb 2, 2025
@AA-Turner
[3.13]GH-121970: Extractmisc_newsinto a new extension (GH-129577…
63cae73
…) (#129586)
(cherry picked from commit ae47888)
AA-Turner added a commit that referenced this pull request Feb 2, 2025
@AA-Turner
[3.12]GH-121970: Extractmisc_newsinto a new extension (GH-129577…
834b9d6
…) (#129587)
(cherry picked from commit ae47888)
@hugovk

hugovk commented Feb 2, 2025

Copy link
Copy Markdown
Member

This removes the PY_MISC_NEWS_DIR environment variable, which was only set/used in make.bat. I've synchronised it with the Makefile, where we always use build/.

cc @zooba: PY_MISC_NEWS_DIR was first added in afe17a7 -- do you still use it elsewhere?

@AA-TurnerAA-Turner mentioned this pull request Feb 3, 2025
Closed
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Feb 7, 2025
@AA-Turner@srinivasreddy
pythonGH-121970: Extractmisc_newsinto a new extension (python#1…
78e48a4
…29577)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixzpicnixzpicnixz approved these changes
@hugovkhugovkAwaiting requested review from hugovkhugovk is a code owner

Assignees

@AA-TurnerAA-Turner

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AA-Turner@picnixz@hugovk