Skip to content
This repository has been archived by the owner on Dec 19, 2024. It is now read-only.

Add a reference using a key from a BibTeX file #11

Open
jezcope opened this issue Aug 26, 2020 · 3 comments
Open

Add a reference using a key from a BibTeX file #11

jezcope opened this issue Aug 26, 2020 · 3 comments
Assignees

Comments

@jezcope
Copy link
Collaborator

jezcope commented Aug 26, 2020

References could be added using a bibtex key, rather than the full reference, and then, when required, retrieve the reference information from a .bib file:

@add_reference(short_purpose="Original implementation of R2T2", key="Alonso2018-1")
def my_great_function():
    pass

This bibtex file should be shipped together with the code, not as part of the documentation. It could double the file use for chache data described in #9 .

@rgaiacs
Copy link
Contributor

rgaiacs commented Sep 1, 2020

I'm against using BibTeX key because it hide changes in the reference to the user.

@dalonsoa
Copy link
Collaborator

dalonsoa commented Sep 2, 2020

Bibtex is widely used when creating the documentation (Sphinx, Doxygen), so using that will ease the adoption of the tool, I think. Besides, there are things - hopefully not that many - that do not have a DOI, specially old books. How do you reference those?

@ChasNelson1990
Copy link

I'll be looking at this this morning.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants