Produce better Misc/NEWS output for Sphinx - #44
Conversation
Sorry, something went wrong.
hugovk
left a comment
There was a problem hiding this comment.
- 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?
Sorry, something went wrong.
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 Doc\html\NEWS. Removing the "What's New" prefixes is still likely fine here. Removing the "Python News" header is more arguable, though I would take the position that Misc/NEWS is solely for our internal consumption since splitting the actual entries to Misc/NEWS.d -- we only create the file during the process of rendering our documentation. To the Windows point, the NEWS file would ordinarily duplicate the content in Doc\html\whatsnew\changelog.html, as the Windows builds ship the rendered documentation, but the Changelog HTML file says " The NEWS file is not available." -- we should probably aim to fix this?
|
Sorry, something went wrong.
|
Note: we currently include Misc/NEWS in the generated release archives. I do think the arguments above still hold, but worth pointing out. https://github.com/python/release-tools/blob/master/release.py#L585-L586 |
Sorry, something went wrong.
| blurbs.load(filenames[0]) | ||
|
|
||
| header = "What's New in Python " + printable_version(version) + "?" | ||
| header = printable_version(version) |
There was a problem hiding this comment.
Something (I'm guessing this line?) is dropping "Python" before the version numbers in the headers, which has a knock-on effect that a lot (but not all) of anchors change from like #python-3-13-0-alpha-4 to #id62:
(main on left, PR on right)
Sorry, something went wrong.
Misc/NEWS is only consumed by Sphinx, which applies several transformations to it. This PR applies those transformations upstream:
xref python/cpython#129577
A