PyRIT icon indicating copy to clipboard operation
PyRIT copied to clipboard

DOC standardize citations across the documentation

Open romanlutz opened this issue 9 months ago • 3 comments

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 avatar Mar 19 '25 22:03 romanlutz

Marking as not ready yet since we had to abandon the bibtex PR. More info in the PR #931

romanlutz avatar Jun 10 '25 06:06 romanlutz

Hi @romanlutz, is this issue still ongoing? If so I would love to work on it

Meggison avatar Oct 09 '25 14:10 Meggison

It is but I don't have a solution... the website generation tool (jupyterbook) we use doesn't have proper support for this it seems.

romanlutz avatar Oct 10 '25 03:10 romanlutz