Generate list of papers that cite sunpy #7094
Closed
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.
Fixes sunpy/sunpy.org#339
I solved this issue in this repo instead of the webpage because this concerns citations of the core package, not the project more broadly.
This uses the
ads
package to automatically generate a list of every paper that has cited the SunPy. Here, I'm defining "cited SunPy" to mean either the 2020 v1.0 paper, the 2015 paper, or the JOSS paper. This is easily extended to others e.g. the Zenodo entries.I'm then using
sphinxcontrib-bibtex
to generate the bibliography. Right now the formatting is a mess. The default BibTeX style does not look nice in our docs. There are ways to define custom styles with this extension (https://sphinxcontrib-bibtex.readthedocs.io/en/latest/usage.html#custom-formatting-sorting-and-labelling) so we could try that. The other option is to do away with bibtex all together and just format the list by hand using the info from the ADS search. However, if we're going to start using this extension anyway (see #7078), then it would be silly to not use it everywhere.This is what things currently look like:
Some remaining todos: