gh-121277: Allow `.. versionadded:: next` in docs by encukou · Pull Request #121278 · python/cpython

encukou · 2024-07-02T17:10:13Z

Issue: Allow .. versionadded:: next in docs #121277

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

- versionadded, versionchanged, and similar directives expand "next" to e.g. "3.14.0a0 (unreleased)". - A tool is provided for release managers to replace all such occurences of "next" with the given string.

gpshead

This looks simpler to implement than I expected it might be, nice!

Doc/tools/extensions/pyspecific.py

AA-Turner

Looks good -- a few comments

Doc/tools/version_next.py

Doc/tools/extensions/pyspecific.py

bedevere-app · 2024-07-18T13:55:11Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

Doc/tools/version_next.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner · 2024-07-19T10:36:25Z

@encukou are you happy if we merge #121971 before this one?

encukou · 2024-07-19T10:36:57Z

Sure.

encukou · 2024-07-19T10:40:23Z

I'll fix the conflicts.

Doc/tools/extensions/pyspecific.py

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

hugovk

Thanks! When merged, please could you drop a note on Discuss to let people know?

encukou · 2024-09-25T21:30:53Z

Will do that after the Devguide PR.

* main: (69 commits) Add "annotate" SET_FUNCTION_ATTRIBUTE bit to dis. (python#124566) pythongh-124412: Add helpers for converting annotations to source format (python#124551) pythongh-119180: Disallow instantiation of ConstEvaluator objects (python#124561) For-else deserves its own section in the tutorial (python#123946) Add 3.13 as a version option to the crash issue template (python#124560) pythongh-123242: Note that type.__annotations__ may not exist (python#124557) pythongh-119180: Make FORWARDREF format look at __annotations__ first (python#124479) pythonGH-58058: Add quick reference for `ArgumentParser` to argparse docs (pythongh-124227) pythongh-41431: Add `datetime.time.strptime()` and `datetime.date.strptime()` (python#120752) pythongh-102450: Add ISO-8601 alternative for midnight to `fromisoformat()` calls. (python#105856) pythongh-124370: Add "howto" for free-threaded Python (python#124371) pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278) pythongh-119400: make_ssl_certs: update reference test data automatically, pass in expiration dates as parameters python#119400 (pythonGH-119401) pythongh-119180: Avoid going through AST and eval() when possible in annotationlib (python#124337) pythongh-124448: Update Windows builds to use Tcl/Tk 8.6.15 (pythonGH-124449) pythongh-123884 Tee of tee was not producing n independent iterators (pythongh-124490) pythongh-124378: Update test_ttk for Tcl/Tk 8.6.15 (pythonGH-124542) pythongh-124513: Check args in framelocalsproxy_new() (python#124515) pythongh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (python#124480) Doc: Use ``major.minor`` for documentation distribution archive filenames (python#124489) ...

miss-islington-app · 2024-09-27T22:28:38Z

Thanks @encukou for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington-app · 2024-09-27T22:28:41Z

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

cherry_picker 7d24ea9db3e8fdca52058629c9ba577aba3d8e5c 3.13

) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9)

bedevere-app · 2024-09-27T23:09:42Z

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

…124718) * gh-121277: Allow `.. versionadded:: next` in docs (GH-121278) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) * gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from e349f73)

…nGH-121278) (pythonGH-124718) * pythongh-121277: Allow `.. versionadded:: next` in docs (pythonGH-121278) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) * pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73) (cherry picked from commit dba992b) Co-authored-by: Petr Viktorin <encukou@gmail.com>

…H-125980) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) (cherry picked from commit 7d24ea9) Also backports a minor fix-up: gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from commit e349f73) Co-authored-by: Petr Viktorin <encukou@gmail.com>

…nGH-121278) (python#124718) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73)

…124718) (#127827) * [3.11] gh-121277: Allow `.. versionadded:: next` in docs (GH-121278) (#124718) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from e349f73) * Import VersionChange sphinx.domains.changeset.VersionChange exists at least since Sphinx 2.1, according to: https://www.sphinx-doc.org/en/master/extdev/deprecated.html * Get config from env * Use version, not arguments directly

bedevere-bot · 2024-12-11T21:24:42Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot s390x RHEL8 Refleaks 3.11 has failed when building commit f0895aa.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/948/builds/843) and take a look at the build logs.
Check if the failure is related to this commit (f0895aa) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/948/builds/843

Failed tests:

test_site
test_audit

Summary of the results of the build (if available):

==

Click to see traceback logs

remote: Enumerating objects: 10, done.        
remote: Counting objects:  10% (1/10)        
remote: Counting objects:  20% (2/10)        
remote: Counting objects:  30% (3/10)        
remote: Counting objects:  40% (4/10)        
remote: Counting objects:  50% (5/10)        
remote: Counting objects:  60% (6/10)        
remote: Counting objects:  70% (7/10)        
remote: Counting objects:  80% (8/10)        
remote: Counting objects:  90% (9/10)        
remote: Counting objects: 100% (10/10)        
remote: Counting objects: 100% (10/10), done.        
remote: Compressing objects:  10% (1/10)        
remote: Compressing objects:  20% (2/10)        
remote: Compressing objects:  30% (3/10)        
remote: Compressing objects:  40% (4/10)        
remote: Compressing objects:  50% (5/10)        
remote: Compressing objects:  60% (6/10)        
remote: Compressing objects:  70% (7/10)        
remote: Compressing objects:  80% (8/10)        
remote: Compressing objects:  90% (9/10)        
remote: Compressing objects: 100% (10/10)        
remote: Compressing objects: 100% (10/10), done.        
remote: Total 10 (delta 0), reused 7 (delta 0), pack-reused 0 (from 0)        
From https://github.com/python/cpython
 * branch                    3.11       -> FETCH_HEAD
Note: switching to 'f0895aa9c1d40d0add673cc51bd143556e22100a'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at f0895aa9c1d [3.11] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (#124718) (#127827)
Switched to and reset branch '3.11'

renaming build/scripts-3.11/pydoc3 to build/scripts-3.11/pydoc3.11
renaming build/scripts-3.11/idle3 to build/scripts-3.11/idle3.11
renaming build/scripts-3.11/2to3 to build/scripts-3.11/2to3-3.11

renaming build/scripts-3.11/pydoc3 to build/scripts-3.11/pydoc3.11
renaming build/scripts-3.11/idle3 to build/scripts-3.11/idle3.11
renaming build/scripts-3.11/2to3 to build/scripts-3.11/2to3-3.11

renaming build/scripts-3.11/pydoc3 to build/scripts-3.11/pydoc3.11
renaming build/scripts-3.11/idle3 to build/scripts-3.11/idle3.11
renaming build/scripts-3.11/2to3 to build/scripts-3.11/2to3-3.11
make: *** [Makefile:1852: buildbottest] Error 2

…H-121278) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73) Updates for 3.10 (cherry-picked from 3.11: f0895aa) * Use version, not arguments directly

bedevere-app · 2024-12-12T13:43:41Z

GH-127867 is a backport of this pull request to the 3.10 branch.

…127867) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from e349f73) Updates for 3.10 (cherry-picked from 3.11: f0895aa) * Use version, not arguments directly

…-121278) (pythonGH-127867) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) pythongh-121277: Raise nice error on `next` as second argument to deprecated-removed (pythonGH-124623) (cherry-picked from e349f73) Updates for 3.9 (cherry-picked from 3.11: f0895aa) (cherry-picked from 3.10: 8773554) * Use version, not arguments directly

bedevere-app · 2024-12-20T10:42:42Z

GH-128117 is a backport of this pull request to the 3.9 branch.

…28117) Make `versionchanged:: next`` expand to current (unreleased) version. When a new CPython release is cut, the release manager will replace all such occurences of "next" with the just-released version. (See the issue for release-tools and devguide PRs.) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> (cherry picked from commit 7d24ea9) gh-121277: Raise nice error on `next` as second argument to deprecated-removed (GH-124623) (cherry-picked from e349f73) (cherry-picked from 3.11: f0895aa) (cherry-picked from 3.10: 8773554)

encukou added 2 commits July 2, 2024 18:39

Make versionchanged:: next` expand to current (unreleased) version

f0005e7

- versionadded, versionchanged, and similar directives expand "next" to e.g. "3.14.0a0 (unreleased)". - A tool is provided for release managers to replace all such occurences of "next" with the given string.

Use in existing docs

0c86239

bedevere-app bot mentioned this pull request Jul 2, 2024

Allow .. versionadded:: next in docs #121277

Closed

6 tasks

gpshead approved these changes Jul 12, 2024

View reviewed changes

bedevere-app bot added the awaiting merge label Jul 12, 2024

encukou commented Jul 18, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

AA-Turner reviewed Jul 18, 2024

View reviewed changes

AA-Turner requested changes Jul 18, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

bedevere-app bot removed the awaiting merge label Jul 18, 2024

bedevere-app bot added the awaiting changes label Jul 18, 2024

merwok reviewed Jul 18, 2024

View reviewed changes

Doc/tools/version_next.py Outdated Show resolved Hide resolved

encukou and others added 9 commits July 19, 2024 11:54

Apply extension suggestions from code review

e270ddc

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Update Doc/tools/extensions/pyspecific.py

0022e1a

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Fix location of the the Doc dir

342838d

Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

Specify encoding

1d9a618

Improve the docstring/usage

311bceb

Re-add stray removed line

72a3162

Split long line

91bd511

Set env before using it

46ae814

Add a blurb

9c4502c

Merge in the main branch

426aae1

AA-Turner reviewed Jul 19, 2024

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Consolidate VersionChange imports

993dd5c

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>

AA-Turner approved these changes Jul 19, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting changes labels Jul 19, 2024

bedevere-app bot added awaiting merge and removed awaiting core review labels Sep 24, 2024

gpshead approved these changes Sep 24, 2024

View reviewed changes

hugovk approved these changes Sep 24, 2024

View reviewed changes

encukou merged commit 7d24ea9 into python:main Sep 25, 2024

bedevere-app bot removed the awaiting merge label Sep 25, 2024

encukou deleted the versionchange-next branch September 25, 2024 21:30

encukou added the needs backport to 3.13 bugs and security fixes label Sep 27, 2024

miss-islington-app bot assigned encukou Sep 27, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 27, 2024

miss-islington mentioned this pull request Oct 25, 2024

[3.12] [3.13] gh-121277: Allow .. versionadded:: next in docs (GH-121278) (GH-124718) #125980

Merged

Uh oh!

Conversation

encukou commented Jul 2, 2024 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gpshead left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bedevere-app bot commented Jul 18, 2024

Uh oh!

Uh oh!

AA-Turner commented Jul 19, 2024

Uh oh!

encukou commented Jul 19, 2024

Uh oh!

encukou commented Jul 19, 2024

Uh oh!

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

encukou commented Sep 25, 2024

Uh oh!

miss-islington-app bot commented Sep 27, 2024

Uh oh!

miss-islington-app bot commented Sep 27, 2024

Uh oh!

bedevere-app bot commented Sep 27, 2024

Uh oh!

bedevere-bot commented Dec 11, 2024

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Uh oh!

bedevere-app bot commented Dec 12, 2024

Uh oh!

bedevere-app bot commented Dec 20, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

encukou commented Jul 2, 2024 •

edited by github-actions bot

Loading