Use sphinxcontrib.apidoc
to automatically generate API docs for entire package
#296
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
Related issues
Closes #290
PR check list
docs/api/internal/
.docs/api/index.rst
.versionadded
,versionchanged
, ordeprecated
directives to docstrings.MAJOR.MINOR.PATCH
(e.g., if the current version is0.2.3
, the next release will be0.3.0
).docs/reference/changelog.md
.📚 Documentation preview 📚: https://ridgeplot--296.org.readthedocs.build/en/296/