Azure
[DRAFT] Add bibtex support, bibliography, and MyST-compatible docstrings
Description
This change sets us up to cite papers in docstrings which wasn't possible before. Most of the change is just formatting fixes in existing docstrings. autodoc had to be replaced with autodoc2 for the MyST support, and bibtex is a new sphinx extension. This also adds a bibliography page that has to be built over time, but I've added one example for now.
Below are a few screenshots of what it looks like:
-
left sidebar
-
docstrings are not rendering right yet, see
Tests and Documentation
This isn't quite possible due to https://github.com/sphinx-extensions2/sphinx-autodoc2/issues/33 at this point. Our Google style docs don't seem to translate properly resulting in references not showing up. I'm closing this for now but we can revisit if that issue ever gets addressed. In fact, the core issue here is not even the one we're facing (since it mentions numpy style and not even jupyterbook) but it might be a first step towards addressing our issue.