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 — Produce better Misc/NEWS output for Sphinx by AA-Turner · Pull Request #44 · python/blurb

Conversation

@AA-Turner

@AA-Turner AA-Turner commented Feb 2, 2025

Copy link
Copy Markdown
Member

Misc/NEWS is only consumed by Sphinx, which applies several transformations to it. This PR applies those transformations upstream:

  • Output b.p.o and GH directives for issue numbers
  • Remove "What's New in ..." prefixes
  • Remove stripped "Python News" header

xref python/cpython#129577

A

Sorry, something went wrong.

Uh oh!

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

All reactions
@AA-Turner
Produce better Misc/NEWS output for Sphinx
de82a01
hugovk
hugovk reviewed Feb 3, 2025
View reviewed changes

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

  • 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.

Uh oh!

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

All reactions
Comment thread src/blurb/blurb.py Resolved

Uh oh!

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

@AA-Turner

AA-Turner commented Feb 3, 2025

Copy link
Copy Markdown
Member Author
  • Remove "What's New in ..." prefixes

I see they don't show up in docs.python.org/3/whatsnew/changelog.html. Are they being removed by one of our Sphinx extensions?

Yes, see https://github.com/python/cpython/blob/HEAD/Doc/tools/extensions/misc_news.py#L33-L35 (originally introduced in python/cpython@44d0c21).

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?

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?

image

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.

@AA-Turner AA-Turner mentioned this pull request Feb 3, 2025
Misc\NEWS in the Windows installer python/release-tools#213
Closed
@AA-Turner

AA-Turner commented Feb 3, 2025

Copy link
Copy Markdown
Member Author

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

All reactions

Sorry, something went wrong.

Uh oh!

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

hugovk
hugovk reviewed Feb 3, 2025
View reviewed changes
Comment thread src/blurb/blurb.py Resolved

Uh oh!

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

Comment thread src/blurb/blurb.py Resolved

Uh oh!

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

hugovk
hugovk reviewed Feb 7, 2025
View reviewed changes
Comment thread src/blurb/blurb.py Resolved

Uh oh!

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

Comment thread src/blurb/blurb.py Outdated
blurbs.load(filenames[0])

header = "What's New in Python " + printable_version(version) + "?"
header = printable_version(version)

@hugovk hugovk Feb 7, 2025

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.

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)

image image

Sorry, something went wrong.

Uh oh!

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

All reactions
@AA-Turner
Merge branch 'main' into misc-news
6065530

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hugovk hugovk hugovk left review comments

Uh oh!

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

Assignees

No one assigned

Labels

None yet

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.

2 participants

@AA-Turner @hugovk
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 01402520 — 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.