docs: add mkdocstrings setup with example API reference#6
Merged
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
github-actions
bot
added
the
documentation
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.
Summary
zensical.tomlwith auto-style docstring detection (NumPy default)mkdocstrings-pythondependency topyproject.tomlmathmodule with Numpydoc-style docstrings (add,fibonacci)docs/api.md) and nav entryCONTRIBUTING.mdwith links to mkdocstrings and Numpydoc style guideTest plan
uv run --group docs zensical serveand verify the API Reference page renders correctlyaddandfibonaccidocstrings display with parameters, returns, raises, and examples sections🤖 Generated with Claude Code