Add a Sphinx docs site and an example on every public entrypoint - #112
Open
jessegrabowski wants to merge 25 commits into
Open
Add a Sphinx docs site and an example on every public entrypoint#112jessegrabowski wants to merge 25 commits into
jessegrabowski wants to merge 25 commits into
Conversation
Read the Docs cannot read a pixi environment, so conda_envs/environment-docs.yml duplicates the docs dependency list that pyproject.toml also carries.
Each block executes in a fresh namespace and its own directory, so an example that omits an import or leans on another one fails rather than shipping broken.
The type aliases move to their defining modules on the API page because autodoc reads an attribute docstring from the module that defines it, not from the package re-exporting it.
A notebook's path sets where it lands: examples/<page>/<section>/nb.ipynb, where a page with no notebooks writes no file rather than a dangling toctree entry.
A type alias carries its docstring under the assignment rather than in __doc__, so the six in optim were never scanned.
Both docstring sweeps parametrize over these, so a collector that quietly returns less takes its own tests with it and the suite stays green.
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
A doctest plugin covers this ground, so the docs no longer claim the suite runs the examples in them.
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
1 participant
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.
The README was the only documentation. This adds a Sphinx site — install and contributing guides, a style guide, an autosummary API reference, and a gallery whose pages and sections come from the folder layout under
examples/.Every public entrypoint also gained a runnable
Examplesblock, and the suite executes them, so a docstring that drops an import fails CI. That's most of the diff.Nothing is published until the Read the Docs project is imported;
.github/workflows/rtd-preview.ymlassumes the slugpytensor-ml.Closes #28