@@ -305,21 +305,14 @@ to perform some manual editing steps.
305
305
release tag in the repo is signed with your gpg key. When prompted
306
306
choose the private key you use for signing release tarballs etc.
307
307
308
- - For a **new branch** release, ``Doc/tools/static/switchers.js``
309
- must be updated in all maintained branches, so that the new maintenance
310
- branch is now ``pre`` (for ``pre-release``) and add the new "dev" version.
311
- Also, update ``Doc/tools/templates/indexsidebar.html`` to
312
- increment the version number of the ``in development`` version
313
- and add an entry under it for the new release branch with ``pre-release``
314
- status. Review the remaining branch entires and consider removing the
315
- oldest ``security-fixes`` branch.
316
- Also, similar changes must be made and committed to these files in all
317
- of the other active branches. Or ask the DE to do this.
318
-
319
- - For a **final** major release, ``Doc/tools/static/switchers.js``
320
- and ``Doc/tools/templates/indexsidebar.html``
321
- must be updated in all maintained branches, changing the release branch
322
- from ``pre-release`` to ``stable``.
308
+ - For a **new branch** release, add it to the ``VERSIONS`` list of
309
+ `docsbuild scripts`_, so that the new maintenance branch is now
310
+ ``pre-release`` and add the new ``in development`` version.
311
+
312
+ - For a **final** major release, update the ``VERSIONS`` list of
313
+ `docsbuild scripts`_: the release branch must be changed from
314
+ ``pre-release`` to ``stable``, tell the DE to update the ``/3/``
315
+ symlink.
323
316
324
317
- For **begin security-only mode** and **end-of-life** releases, review the
325
318
two files and update the versions accordingly in all active branches.
@@ -391,7 +384,7 @@ to perform some manual editing steps.
391
384
- The WE has one checkout tree per target architecture, and builds the
392
385
pcbuild.sln project for the appropriate architecture.
393
386
394
- - PC\icons.mak must have been run with nmake.
387
+ - PC\\ icons.mak must have been run with nmake.
395
388
396
389
- The cmd.exe window in which this is run must have Cygwin/bin in its
397
390
path (at least for x86).
@@ -454,19 +447,13 @@ to perform some manual editing steps.
454
447
unpack the HTML docs to ``/srv/docs.python.org/release/X.Y.Z[rcA]`` on
455
448
docs.nyc1.psf.io. Make sure the files are in group ``docs`` and are
456
449
group-writeable. If it is a release of a security-fix-only version,
457
- tell the DE to build a version with the "version switcher"
458
- and put it there .
450
+ tell the DE to start a build (``security-fixes`` and ``EOL`` version
451
+ are not built daily) .
459
452
460
453
- Let the DE check if the docs are built and work all right.
461
454
462
455
- If this is a **final** major release: Tell the DE to adapt redirects for
463
- docs.python.org/X.Y in the nginx config for docs.python.org, update
464
- the `docsbuild-scripts <https://github.com/python/docsbuild-scripts>`_
465
- to point to the right stable/development branches, and to install it
466
- and make the initial checkout.
467
- The Doc's ``switchers.js`` script also needs to be
468
- updated. In general, please don't touch things in the toplevel
469
- ``/srv/docs.python.org/`` directory unless you know what you're doing.
456
+ docs.python.org/X.Y in the nginx config for docs.python.org.
470
457
471
458
- Note both the documentation and downloads are behind a caching CDN. If
472
459
you change archives after downloading them through the website, you'll
@@ -895,10 +882,8 @@ else does them. Some of those tasks include:
895
882
- Optionally making a final release to publish any remaining unreleased
896
883
changes.
897
884
898
- - Check the `docsbuild server script
899
- <https://github.com/python/docsbuild-scripts/blob/master/build_docs.py>`_
900
- to ensure that the docs set for the branch is no longer being built.
901
- If still present, ask the DE to remove this branch from the BRANCHES list.
885
+ - Update the ``VERSIONS`` list of `docsbuild scripts`_: change the
886
+ version state to ``EOL``.
902
887
903
888
- On the docs download server (docs.nyc1.psf.io), ensure the top-level
904
889
symlink points to the upload of unpacked html docs from final release::
@@ -907,17 +892,6 @@ else does them. Some of those tasks include:
907
892
ls -l 3.3
908
893
lrwxrwxrwx 1 nad docs 13 Sep 6 21:38 3.3 -> release/3.3.7
909
894
910
- - In each unretired cpython branch, remove any remaining references to the
911
- retired branch in the Doc version switcher and side bar templates
912
- (file names may vary between branches) [DE]::
913
-
914
- Doc/tools/static/switchers.js
915
- Doc/tools/templates/indexsidebar.html
916
-
917
- Note that the best way to do this is to make the change in the current
918
- `master` branch, then backport to the other active branches. (This will
919
- hopefully pacify the current state-of-the-art nannybots.)
920
-
921
895
- Freeze the state of the release branch by creating a tag of its current HEAD
922
896
and then deleting the branch from the cpython repo. The current HEAD should
923
897
be at or beyond the final security release for the branch::
@@ -1019,6 +993,9 @@ Copyright
1019
993
This document has been placed in the public domain.
1020
994
1021
995
996
+ .. _docsbuild scripts:
997
+ https://github.com/python/docsbuild-scripts/blob/master/build_docs.py
998
+
1022
999
..
1023
1000
Local Variables:
1024
1001
mode: indented-text
0 commit comments