Add ability to attach citations in docstrings and markdown pages#12
Draft
Add ability to attach citations in docstrings and markdown pages#12
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
scanpy is very rigourous in that many of it's methods and recipes cite scholarly sources. For example:
https://scanpy.readthedocs.io/en/stable/api/preprocessing.html
It would nice to try to do the same, to set ourselves off on the right foot.
The documentation tool we're using (mkdocs and mkdocs-material) doesn't have as much selection for extensions to help with citations. The only available plugin is no longer maintained, but I gave it a shot anyhow:
https://github.com/shyamd/mkdocs-bibtex
What this does so far:
docs/references.bibfile