Create a list with all the papers that cite yours
Project description
sphinxcontrib-citations
It is often the case that open-source software enables new scientific
developments. When this happens, it is desirable to highlight which new results
were obtained with a given piece of software. If your project has one or more
associated published resources (for example, in the Journal of Open-Source
Software, or in Zenodo), you can use sphinxcontrib-citations
to generate a
page in your documentations that lists the papers that cite your code.
sphinxcontrib-citations
is an Sphinx extension that uses NASA's ADS to look up
which papers cite a given list of references. sphinxcontrib-citations
is
currently in a state of minimum-viable-product: the basic features are
available, but not much else. Pull request are welcome.
To use sphinxcontrib-citations
, first install it and add it to the
extensions
variable in your conf.py
as sphinxcontrib.citations
.
sphinxcontrib-citations
has only three options:
citations_ads_token
: this is the ADS API token, and it required for the correct functioning of the extension.citations_bibcode_list
: this is the list of bibcodes for which citations have to be found. You can find the bibcode for a given paper on ADS.citations_bibtex_file
: this is the name of the.bib
file that will be generated. If not specified, it will besphinxcontrib_citations.bib
.
When you compile your documentation, sphinxcontrib-citations
will find all the
references and create a bib
file. Then, sphinxcontrib-citations
interfaces
with sphinxcontrib-bibtex
to produce the page. You can use all the options
provided by that package. A simple page might look like:
Papers citing this software
=============================================
.. bibliography:: sphinxcontrib_citations.bib
:list: enumerated
:all:
Make sure that the name of the file matches your choice for
citations_bibtex_file
.
Example
For an example, see kuibit.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib_citations-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc1369c698ed7a3af95e65af54769e2345399adbda7653e79006ca961f8d5333 |
|
MD5 | e587a24c0786fb6edcc730cfbc2e3fd2 |
|
BLAKE2b-256 | c9c4f67327011e1891c3a9f9747dff22fd5f732f956a34422bc4eefd356d62ae |
Hashes for sphinxcontrib_citations-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32fa84ce248b66b72a3aa70f309ea318a585c6b67225e57b1f28f7faa0379708 |
|
MD5 | 7f78376e390ed867ab1bd53ac94a6bd8 |
|
BLAKE2b-256 | e383030570a93b616661ef75f05aaec646de80853738596202d7c1a180d23069 |