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.

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

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

Merged
merged 2 commits into from
Aug 17, 2023

Conversation

MattF-NSIDC
Copy link

Description

title! closes #634

Checklist

If an item on this list is done or not needed, check it with [x] or click the
checkbox.

  • The PR description links to issues that it resolves with closes #{issue_number}
  • Config lockfile updated (inv config.export > qgreenland/config/cfg-lock.json)
  • Environment lockfile updated if needed (conda-lock)
  • Version bumped if needed (bumpversion (major|minor|patch|prerelease|build))
  • CHANGELOG.md updated (for user-facing changes)
  • Documentation updated if needed
  • New unit tests if needed

- sphinx-selective-exclude ~=1.0.3
# TODO: get this dependency from conda-forge (see https://github.com/callowayproject/bump-my-version/issues/46)
- bump-my-version ~=0.9.2
Copy link
Author

Choose a reason for hiding this comment

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

All but one is now on conda-forge. I was hoping to get rid of this whole section!

@@ -38,12 +38,21 @@ 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

"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

- sphinx ~=4.3.1
# TODO: Upgrade sphinx ones sphinx-rtd-theme supports 7
# - sphinx ~=7.2.2
- sphinx ~=6.2.1
Copy link
Author

Choose a reason for hiding this comment

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

I was getting some weird error that just went away when I upgraded.

Copy link
Contributor

@trey-stafford trey-stafford left a comment

Choose a reason for hiding this comment

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

Cool!

@MattF-NSIDC MattF-NSIDC merged commit 5aa8e0d into main Aug 17, 2023
2 checks passed
@MattF-NSIDC MattF-NSIDC deleted the bump-citation-docs branch August 17, 2023 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Keep version number in documentation citation up-to-date with bumpversion
3 participants