Skip to content

Produce better Misc/NEWS output for Sphinx #44

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Produce better Misc/NEWS output for Sphinx #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de82a01
Produce better Misc/NEWS output for Sphinx
AA-Turner Feb 2, 2025
6065530
Merge branch 'main' into misc-news
AA-Turner Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/blurb/_blurb_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
Format of the BODY section:

* The BODY section should be a single paragraph of English text
in ReST format. It should not use the following ReST markup
in reST format. It should not use the following reST markup
features:
* section headers
* comments
Expand All @@ -49,7 +49,7 @@
(This formatting will be inserted when rendering the final output.)
* Lines longer than 76 characters will be wordwrapped.
* In the final output, the first line will have
"- gh-issue-<gh-issue-number>: " inserted at the front,
"- :gh:`<gh-issue-number>`: " inserted at the front,
and subsequent lines will have two spaces inserted
at the front.

Expand Down
15 changes: 3 additions & 12 deletions src/blurb/_merge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,6 @@ def write_news(output: str, *, versions: list[str]) -> None:
def prnt(msg: str = '', /):
buff.append(msg)

prnt(
"""
+++++++++++
Python News
+++++++++++

""".strip()
)

for version in versions:
filenames = glob_blurbs(version)

Expand All @@ -70,7 +61,7 @@ def prnt(msg: str = '', /):
assert len(filenames) == 1
blurbs.load(filenames[0])

header = f"What's New in Python {printable_version(version)}?"
header = printable_version(version)
prnt()
prnt(header)
prnt('=' * len(header))
Expand Down Expand Up @@ -98,11 +89,11 @@ def prnt(msg: str = '', /):
if metadata.get('gh-issue'):
issue_number = metadata['gh-issue']
if int(issue_number):
body = f'gh-{issue_number}: {body}'
body = f":gh:`{issue_number}`: {body}"
elif metadata.get('bpo'):
issue_number = metadata['bpo']
if int(issue_number):
body = f'bpo-{issue_number}: {body}'
body = f":issue:`{issue_number}`: {body}"

body = f'- {body}'
text = textwrap_body(body, subsequent_indent=' ')
Expand Down