Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 32b020a

Browse files
tacaswellQuLogic
authored andcommitted
DOC: update release guide to use zenodo DL script
1 parent 3a99a28 commit 32b020a

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

doc/devel/release_guide.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,12 +219,23 @@ Via the `GitHub UI
219219
pushed tag into a release. If this is a pre-release remember to mark
220220
it as such.
221221

222-
For final releases, also get the DOI from `zenodo <https://zenodo.org/>`__
223-
(which will automatically produce one once the tag is pushed), add the DOI link
224-
to :file:`doc/citing.rst`, commit to the VER-doc branch and push to GitHub ::
222+
For final releases, also get the DOI from `zenodo
223+
<https://zenodo.org/>`__ (which will automatically produce one once
224+
the tag is pushed). Add the doi post-fix and version to the dictionary in
225+
:file:`tools/cache_zenodo_svg.py` and run the script (requires ``httpx``).
226+
227+
228+
This will download the new svg to the :file:`_static` directory
229+
in the docs and print the restructured text that needs to be put into
230+
:file:`doc/citing.rst`. Commit the new svg, the change to
231+
:file:`tools/cache_zenodo_svg.py`, and the changes to
232+
:file:`doc/citing.rst` to the VER-doc branch and push to GitHub. ::
225233

226234
git checkout v2.0.0-doc
235+
$EDITOR tools/cache_zenodo_svg.py
236+
python tools/cache_zenodo_svg.py
227237
$EDITOR doc/citing.html
238+
git commit -a
228239
git push DANGER v2.0.0-doc:v2.0.0-doc
229240

230241
.. _release_bld_bin:

0 commit comments

Comments
 (0)