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.

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

DOC standardize citations across the documentation #807

Open
3 tasks
romanlutz opened this issue Mar 19, 2025 · 0 comments
Open
3 tasks

DOC standardize citations across the documentation #807

romanlutz opened this issue Mar 19, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@romanlutz
Copy link
Contributor

Describe the issue linked to the documentation

Right now, each class (and every example notebook) does something custom. Sometimes we mention the authors, sometimes we don't. Sometimes there's a link, sometimes there isn't. Sometimes we mention the paper title, sometimes we don't. We should err on the side of always including as much information as possible as people deserve credit for their fantastic contributions to open science.

This should happen as follows:

  • add a bib file similar to https://github.com/fairlearn/fairlearn/blob/main/docs/refs.bib that holds the bibtex references and add a dev dependency on sphinxcontrib-bibtex. Migrate at least one file's citations to this system for testing purposes. This may require including something like .. footbibliography:: (or rather, the MyST equivalent of this ReST command).
  • add a page with all works that we cite and link to it from the landing page
  • replace all existing citations with this while making sure that author names, paper titles, any bibtex metadata, link to paper (and optionally repo/dataset location if available) are included!

Context on citing in jupyterbook: https://jupyterbook.org/en/stable/content/citations.html

@romanlutz romanlutz self-assigned this Mar 19, 2025
@romanlutz romanlutz added the documentation Improvements or additions to documentation label Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant