Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use Myst substitution extension to populate version in citation text #740

Merged
merged 2 commits into from
Aug 17, 2023
Merged

Use Myst substitution extension to populate version in citation text #740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70d2b61
Use Myst substitution extension to populate version in citation text
mfisher87 Aug 17, 2023
ecedba9
Generalize non-latest-version citations
mfisher87 Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions doc/citing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I felt latest at top, descending order was more intuitive


> 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)


Expand Down
6 changes: 6 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@
# -- MyST options -------------------------------------------------

myst_heading_anchors = 3
myst_enable_extensions = [
"substitution",
]
myst_substitutions = {
"release": release,
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Enables jinja syntax for substitution

}


# -- Options for HTML output -------------------------------------------------
Expand Down
Loading