Add sphinx docs#24
Closed
jessegrabowski wants to merge 14 commits into
Closed
Conversation
Member
Author
|
Closes #14 |
jessegrabowski
force-pushed
the
docs/sphinx-setup
branch
from
49bb3ef to
d49c85e
Compare
Collaborator
|
stoked |
bwengals
approved these changes
May 29, 2026
Three independent fixes: (1) escape ``|grad|`` in check_init's docstring so docutils stops trying to resolve it as a substitution reference, (2) teach numpydoc the project-specific section headers it was warning about, (3) emit a hidden toctree from the notebook gallery so MyST-NB files stop triggering "not included in any toctree" warnings.
jessegrabowski
force-pushed
the
docs/sphinx-setup
branch
from
3540a6d to
2bcca71
Compare
Open
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
2 participants
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.
@bwengals you will need to set up read-the-docs to host all this.
To see the preview, check out this branch then do:
That will build a static page and launch a browser. Would be cool if @thomaspinder you could also take a look and weigh in, especially on the covariance gallery. I used the preliz distribution gallery as inspiration (aka i ripped it off)