Copying over the basic setup of documentation from dolphin. It uses MkDocs, and the MkdocStrings for autogenerating the reference material. Once you install the requirements in docs/requirements.txt, you can locally view the docs with mkdocs serve:
You can cite using the references in docs/references.bib. So in docstrings or other markdown docs, we can add @[Pepe2006ExtensionMinimumCost] and it'll look like this:
You can make a jupyter notebook, store it in docs/notebooks/, and have it rendered in the docs. See here for an example
Copying over the basic setup of documentation from dolphin. It uses MkDocs, and the MkdocStrings for autogenerating the reference material. Once you install the requirements in
docs/requirements.txt, you can locally view the docs withmkdocs serve:Other features:
docs/references.bib. So in docstrings or other markdown docs, we can add@[Pepe2006ExtensionMinimumCost]and it'll look like this:docs/notebooks/, and have it rendered in the docs. See here for an example