Skip to content

Commit b5f5a52

Browse files
committed
Add instructions on manually rebuilding a branch
1 parent b2b5483 commit b5f5a52

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ This repository contains scripts for automatically building the Python
22
documentation on [docs.python.org](https://docs.python.org).
33

44

5-
# How to test it?
5+
## How to test it?
66

77
The following command should build all maintained versions and
88
translations in `./www`, beware it can take a few hours:
@@ -15,7 +15,7 @@ If you don't need to build all translations of all branches, add
1515
`--language en --branch main`.
1616

1717

18-
# Check current version
18+
## Check current version
1919

2020
Install `tools_requirements.txt` then run `python check_versions.py
2121
../cpython/` (pointing to a real CPython clone) to see which version

RELEASING.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Manually rebuild a branch
2+
3+
Docs for [feature and bugfix branches](https://devguide.python.org/versions/) are
4+
automatically built from a cron.
5+
6+
Manual rebuilds are needed for new security releases,
7+
and to add the end-of-life banner for newly end-of-life branches.
8+
9+
To manually rebuild a branch, for example 3.11:
10+
11+
```shell
12+
ssh docs.nyc1.psf.io
13+
sudo su --shell=/bin/bash docsbuild
14+
screen -DUR # Rejoin screen session if it exists, otherwise create a new one
15+
/srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --branch 3.11
16+
```

0 commit comments

Comments
 (0)