Skip to content

Commit 8e9d918

Browse files
authored
DOC: update documentation release process [skip actions][skip azp][skip cirrus] (numpy#27247)
1 parent 64caed3 commit 8e9d918

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

doc/Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,12 +118,14 @@ endif
118118
tar -C build/merge/$(TAG) -xf build/dist.tar.gz
119119
git -C build/merge add $(TAG)
120120
@# For now, the user must do this. If it is onerous, automate it and change
121-
@# the instructions in doc/HOWTO_RELEASE.rst
121+
@# the instructions in doc/RELEASE_WALKTHROUGH.rst
122122
@echo " "
123123
@echo New documentation archive added to ./build/merge.
124124
@echo Now add/modify the appropriate section after
125125
@echo " <!-- insert here -->"
126126
@echo in build/merge/index.html,
127+
@echo change _static/versions.json,
128+
@echo and run \"python3 update.py\"
127129
@echo then \"git commit\", \"git push\"
128130

129131

doc/RELEASE_WALKTHROUGH.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -272,18 +272,17 @@ If the release series is a new one, you will need to add a new section to the
272272
$ gvim index.html +/'insert here'
273273

274274
Further, update the version-switcher json file to add the new release and
275-
update the version marked `(stable)`::
275+
update the version marked ``(stable)`` and ``preferred``::
276276

277277
$ gvim _static/versions.json
278278

279-
Otherwise, only the ``zip`` link should be updated with the new tag name. Since
280-
we are no longer generating ``pdf`` files, remove the line for the ``pdf``
281-
files if present::
279+
Then run ``update.py`` to update the version in ``_static``::
282280

283-
$ gvim index.html +/'tag v1.21'
281+
$ python3 update.py
284282

285283
You can "test run" the new documentation in a browser to make sure the links
286-
work::
284+
work, although the version dropdown will not change, it pulls its information
285+
from ``numpy.org``::
287286

288287
$ firefox index.html # or google-chrome, etc.
289288

@@ -294,9 +293,8 @@ Update the stable link and update::
294293

295294
Once everything seems satisfactory, update, commit and upload the changes::
296295

297-
$ python3 update.py
298296
$ git commit -a -m"Add documentation for v1.21.0"
299-
$ git push
297+
$ git push [email protected]:numpy/doc
300298
$ popd
301299

302300

0 commit comments

Comments
 (0)