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.

Sign up for GitHub

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

Jump to bottom

Documentation: update citation guidelines #1297

Closed
halfflat opened this issue Jan 6, 2021 · 1 comment · Fixed by #1481
Closed

Documentation: update citation guidelines #1297

halfflat opened this issue Jan 6, 2021 · 1 comment · Fixed by #1481
Assignees
@brenthuisman
Labels
documentation Documentation itself, or building and deployment of documentation.

Comments

@halfflat
Copy link
Contributor

halfflat commented Jan 6, 2021

The RTD documentation only mentions the article citation, and the README offers only Zenodo DOIs for the software (as opposed to the published article).

We should make it easy for others to cite the software itself, as well as the article discussing it, by providing a full example citation and cut-and-pasteable BibTeX entry.
@halfflat halfflat added the documentation Documentation itself, or building and deployment of documentation. label Jan 6, 2021
@brenthuisman
Copy link
Contributor

  1. Let's have Nora's name fixed.
  2. Bibtex entry for Zenodo.

@brenthuisman brenthuisman self-assigned this Mar 25, 2021
@brenthuisman brenthuisman mentioned this issue Apr 8, 2021
Merged
brenthuisman added a commit that referenced this issue Apr 12, 2021
@brenthuisman
Update citation section (#1481)
eeb01bc 
* Add Zenodo citation snippet.
* Correct Nora's last name, which is Abi Akar.
* Small css fix for change in docutils, see: readthedocs/sphinx_rtd_theme#1115

Fixes #1297.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brenthuisman brenthuisman

Labels
documentation Documentation itself, or building and deployment of documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update citation section brenthuisman/arbor
2 participants
@halfflat @brenthuisman