Skip to content
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

Jump to bottom

Doc: Use major.minor for documentation distribution archive filenames #124489

Merged
merged 2 commits into from
Sep 25, 2024
Merged

Doc: Use major.minor for documentation distribution archive filenames #124489

merged 2 commits into from
Sep 25, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Sep 25, 2024 •
edited by github-actions bot
Loading

Per python/docs-community#131, this adjusts the documentation archive filenames to only include "major.minor".

Ned outlines a key motivating point:

"python-3.12.5-docs-pdf-a4.zip neither reflects the state of the documentation at the time of the 3.12.5 release nor necessarily the final state of the 3.12 docs prior to the 3.12.6 release; it's just what existed in the 3.12 git branch the last time the cron started building (and successfully finished) before the 3.12.6 release was merged into the 3.12 branch."

By just using x.y we are honest that the download reflects the state of the website rather than any one release -- for that, use https://docs.python.org/release/.

This patch changes patchlevel.py to return the major.minor version rather than the full release version. This is picked up in the Makefile as $(DISTVERSION) and interpolated into the filenames.

A

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

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip issue skip news needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Sep 25, 2024
@AA-Turner AA-Turner mentioned this pull request Sep 25, 2024
Closed
@ned-deily
Copy link
Member

The file names don't seem to have been changed with the current version of the PR (see the RTD preview index page)?

@AA-Turner
Copy link
Member Author

The file names don't seem to have been changed with the current version of the PR (see the RTD preview index page)?

Do you mean https://cpython-previews--124489.org.readthedocs.build/en/124489/download.html? This is linked to the static release files uploaded by RMs, it's only the daily builds (run with -Adaily=1) that will have the new filenames/links.

A

@ned-deily
Copy link
Member

Doh!

ned-deily
ned-deily approved these changes Sep 25, 2024
View reviewed changes
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@AA-Turner AA-Turner merged commit 6318ffc into python:main Sep 25, 2024
25 checks passed
@AA-Turner AA-Turner deleted the docs/dist-major-minor branch September 25, 2024 19:06
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
@AA-Turner @miss-islington
Doc: Use major.minor for documentation distribution archive filen…
b2e72f5 
…ames (pythonGH-124489)

(cherry picked from commit 6318ffc)

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

bedevere-app bot commented Sep 25, 2024

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
@AA-Turner @miss-islington
Doc: Use major.minor for documentation distribution archive filen…
1052119 
…ames (pythonGH-124489)

(cherry picked from commit 6318ffc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 25, 2024
@bedevere-app
Copy link

bedevere-app bot commented Sep 25, 2024

GH-124535 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 25, 2024
AA-Turner added a commit that referenced this pull request Sep 25, 2024
@miss-islington @AA-Turner
[3.12] Doc: Use major.minor for documentation distribution archiv…
ea5c650 
…e filenames (GH-124489) (#124535)

Doc: Use ``major.minor`` for documentation distribution archive filenames (GH-124489)
(cherry picked from commit 6318ffc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
emilyemorehouse added a commit to lysnikolaou/cpython that referenced this pull request Sep 26, 2024
@emilyemorehouse
Merge branch 'main' into fix-help-double-prompt
4cdb3ae 
* 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)
  ...
Yhg1s pushed a commit that referenced this pull request Sep 26, 2024
@miss-islington @AA-Turner
[3.13] Doc: Use major.minor for documentation distribution archiv…
068e734 
…e filenames (GH-124489) (#124534)

Doc: Use ``major.minor`` for documentation distribution archive filenames (GH-124489)
(cherry picked from commit 6318ffc)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk hugovk mentioned this pull request Dec 5, 2024
Closed
@robmoss2k robmoss2k mentioned this pull request Dec 10, 2024
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ned-deily ned-deily ned-deily approved these changes

@hugovk hugovk Awaiting requested review from hugovk hugovk is a code owner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AA-Turner @ned-deily