MNT: have the helper script edit citing.rst

tacaswell · QuLogic · commit 6146e9ab72bb · 2020-06-06T05:03:15.000-04:00
diff --git a/doc/citing.rst b/doc/citing.rst
@@ -36,6 +36,8 @@ specific DOI from the link, referring to the version used for your publication.
 
 By version
 ~~~~~~~~~~
+.. START OF AUTOGENERATED
+
 
 v3.2.1
    .. image:: _static/3714460.svg
@@ -127,3 +129,5 @@ v1.4.1
 v1.4.0
    .. image:: _static/11451.svg
       :target:  https://doi.org/10.5281/zenodo.11451
+
+.. END OF AUTOGENERATED
diff --git a/doc/devel/release_guide.rst b/doc/devel/release_guide.rst
@@ -222,13 +222,12 @@ it as such.
 For final releases, also get the DOI from `zenodo
 <https://zenodo.org/>`__ (which will automatically produce one once
 the tag is pushed).  Add the doi post-fix and version to the dictionary in
-:file:`tools/cache_zenodo_svg.py`  and run the script (requires ``httpx``).
+:file:`tools/cache_zenodo_svg.py` and run the script.
 
 
-This will download the new svg to the :file:`_static` directory
-in the docs and print the restructured text that needs to be put into
-:file:`doc/citing.rst`.  Commit the new svg, the change to
-:file:`tools/cache_zenodo_svg.py`, and the changes to
+This will download the new svg to the :file:`_static` directory in the
+docs and edit :file:`doc/citing.rst`.  Commit the new svg, the change
+to :file:`tools/cache_zenodo_svg.py`, and the changes to
 :file:`doc/citing.rst` to the VER-doc branch and push to GitHub. ::
 
   git checkout v2.0.0-doc
diff --git a/tools/cache_zenodo_svg.py b/tools/cache_zenodo_svg.py
@@ -93,17 +93,38 @@ def _get_xdg_cache_dir():
         "v1.4.1": "12287",
         "v1.4.0": "11451",
     }
-    target_dir = Path(__file__).parent.parent.absolute() / "doc" / "_static"
+    doc_dir = Path(__file__).parent.parent.absolute() / "doc"
+    target_dir = doc_dir / "_static"
+    citing = doc_dir / "citing.rst"
 
-    for version, doi in data.items():
-        svg_path = target_dir / f"{doi}.svg"
-        if not svg_path.exists():
-            url = f"https://zenodo.org/badge/doi/10.5281/zenodo.{doi}.svg"
-            payload = download_or_cache(url, f"{doi}.svg")
-            with open(svg_path, "xb") as fout:
-                fout.write(payload.read())
-        print(
-            f"""{version}
+    header = []
+    footer = []
+    with open(citing, "r") as fin:
+        target = header
+        for ln in fin:
+            if target is not None:
+                target.append(ln.rstrip())
+            if ln.strip() == ".. START OF AUTOGENERATED":
+                target.extend(["", ""])
+                target = None
+            if ln.strip() == ".. END OF AUTOGENERATED":
+                target = footer
+                target.append(ln)
+
+    with open(citing, "w") as fout:
+        fout.write("\n".join(header))
+        for version, doi in data.items():
+            svg_path = target_dir / f"{doi}.svg"
+            if not svg_path.exists():
+                url = f"https://zenodo.org/badge/doi/10.5281/zenodo.{doi}.svg"
+                payload = download_or_cache(url, f"{doi}.svg")
+                with open(svg_path, "xb") as fout:
+                    fout.write(payload.read())
+            fout.write(
+                f"""
+{version}
    .. image:: _static/{doi}.svg
       :target:  https://doi.org/10.5281/zenodo.{doi}"""
-        )
+            )
+        fout.write("\n\n")
+        fout.write("\n".join(footer))
