-
Notifications
You must be signed in to change notification settings - Fork 711
Closed
Task
1 / 11 of 1 issue completed
Copy link
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnot ready yetThis issue needs more definition or is blocked by a pending change.This issue needs more definition or is blocked by a pending change.
Description
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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnot ready yetThis issue needs more definition or is blocked by a pending change.This issue needs more definition or is blocked by a pending change.