-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Produce better Misc/NEWS output for Sphinx #44
base: main
Are you sure you want to change the base?
Conversation
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.
- Remove "What's New in ..." prefixes
I see they don't show up in https://docs.python.org/3/whatsnew/changelog.html. Are they being removed by one of our Sphinx extensions?
It might be that the Windows installer is ingesting the NEWS
file without Sphinx processing, but perhaps it's fine to remove these prefixes anyway, because the changelog isn't the same as our carefully edited "What's New in Python" documents?
Yes, see https://github.com/python/cpython/blob/HEAD/Doc/tools/extensions/misc_news.py#L33-L35 (originally introduced in python/cpython@44d0c21).
Having checked my local installations, the NEWS file is indeed included in To the Windows point, the NEWS file would ordinarily duplicate the content in |
Note: we currently include https://github.com/python/release-tools/blob/master/release.py#L585-L586 |
@@ -1013,7 +1006,7 @@ def print(*a, sep=" "): | |||
assert len(filenames) == 1 | |||
blurbs.load(filenames[0]) | |||
|
|||
header = "What's New in Python " + printable_version(version) + "?" | |||
header = printable_version(version) |
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.
Misc/NEWS
is only consumed by Sphinx, which applies several transformations to it. This PR applies those transformations upstream:xref python/cpython#129577
A