Merge pull request #740 from nsidc/bump-citation-docs

Use Myst substitution extension to populate version in citation text
nsidc · Aug 17, 2023 · 5aa8e0d · 5aa8e0d
2 parents 7d4f204 + ecedba9
commit 5aa8e0d
Show file tree

Hide file tree

Showing 5 changed files with 318 additions and 186 deletions.
diff --git a/doc/citing.md b/doc/citing.md
@@ -38,31 +38,40 @@ Please choose the appropriate citation depending on which you use.
 An asterisk (`*`) indicates co-equal lead authorship (listed alphabetically).
 
 
-### Version 1.0
+### Latest version: {{ release }}
 
-> Moon, T., Fisher, M., Harden, L., and T. Stafford (2021). QGreenland (v1.0.0)
+> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland ({{ release }})
 > [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
 
-> *Fisher, M., *Stafford, T., Moon, T., and L. Harden (2021). QGreenland (v1.0.0)
+> *Fisher, M., *Stafford, T., T. Moon, and A. Thurber (2023). QGreenland ({{ release }})
 > [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
 
 
-### Version 2.0
+### Version 3
+
+> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland (v3)
+> [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
+
+> *Fisher, M., *Stafford, T., T. Moon, and A. Thurber (2023). QGreenland (v3)
+> [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
+
+
+### Version 2
 
 > Moon, T., Fisher, M., Harden, L., Simonoko, H., and T. Stafford (2022). QGreenland
-> (v2.0.0) [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
+> (v2) [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
 
-> *Fisher, M., *Stafford, T., Moon, T., HArden, L., and H. Simonoko (2022). QGreenland
-> (v2.0.0) [software], [National Snow and Ice Data
+> *Fisher, M., *Stafford, T., Moon, T., Harden, L., and H. Simonoko (2022). QGreenland
+> (v2) [software], [National Snow and Ice Data
 > Center](https://github.com/nsidc/qgreenland)
 
 
-### Version 3.0
+### Version 1
 
-> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland (v3.0.0)
+> Moon, T., Fisher, M., Harden, L., and T. Stafford (2021). QGreenland (v1)
 > [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
 
-> *Fisher, M., *Stafford, T., T. Moon, and A. Thurber (2023). QGreenland (v3.0.0)
+> *Fisher, M., *Stafford, T., Moon, T., and L. Harden (2021). QGreenland (v1)
 > [software], [National Snow and Ice Data Center](https://github.com/nsidc/qgreenland)
 
 

diff --git a/doc/conf.py b/doc/conf.py
@@ -64,6 +64,12 @@
 # -- MyST options -------------------------------------------------
 
 myst_heading_anchors = 3
+myst_enable_extensions = [
+    "substitution",
+]
+myst_substitutions = {
+    "release": release,
+}
 
 
 # -- Options for HTML output -------------------------------------------------