Repository navigation
[DRAFT] Add bibtex support, bibliography, and MyST-compatible docstrings - #864
Closed
Roman Lutz (romanlutz) wants to merge 6 commits into
Closed
Roman Lutz (romanlutz) wants to merge 6 commits into
Roman Lutz (romanlutz) wants to merge 6 commits into
Conversation
…pply_chat_template
Roman Lutz (romanlutz)
changed the title
Richard Lundeen (richlundeen)
approved these changes
Apr 10, 2025
Contributor
Author
|
This is not ready 🤣 don't merge. The param and returns parts are broken |
Contributor
Author
|
This isn't quite possible due to sphinx-extensions2/sphinx-autodoc2#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. |
Closed
6 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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