Skip to content

Build API reference: add mkdocstrings pages for all public classes and wire docs dep group#412

Merged
tschm merged 3 commits intomainfrom
copilot/add-mkdocs-mkdocstrings
Mar 23, 2026
Merged

Build API reference: add mkdocstrings pages for all public classes and wire docs dep group#412
tschm merged 3 commits intomainfrom
copilot/add-mkdocs-mkdocstrings

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 23, 2026

The MkDocs site only had reference pages for Data and Stats, leaving Portfolio, build_data, Plots, and Reports undocumented. The docs toolchain also had no declared dependencies, relying entirely on ad-hoc uvx installs.

Changes

New reference pages (docs/reference/)

  • api.mdbuild_data() function
  • portfolio.mdPortfolio class
  • plots.mdPlots class
  • reports.mdReports class

docs/mkdocs.yml — extended nav to surface all six reference pages; existing mkdocstrings config (Google-style, show_signature_annotations, members_order: source) renders per-method docs automatically from existing docstrings.

pyproject.toml — added docs dependency group (mkdocs, mkdocs-material, mkdocstrings[python]) so uv sync --all-groups in rhiza_book.yml installs them deterministically rather than relying solely on ephemeral uvx resolution.

No workflow changes required — rhiza_book.yml already calls make bookmkdocs-build.

Original prompt

This section details on the original issue you should resolve

<issue_title>Build API reference — Add mkdocs + mkdocstrings to generate per-function docs from existing docstrings; wire into rhiza_book.yml</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

@tschm tschm marked this pull request as ready for review March 23, 2026 11:33
Copilot AI changed the title [WIP] Build API reference by adding mkdocs and mkdocstrings Build API reference: add mkdocstrings pages for all public classes and wire docs dep group Mar 23, 2026
Copilot AI requested a review from tschm March 23, 2026 11:34
@tschm tschm merged commit ff95a45 into main Mar 23, 2026
21 checks passed
@tschm tschm deleted the copilot/add-mkdocs-mkdocstrings branch March 23, 2026 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Build API reference — Add mkdocs + mkdocstrings to generate per-function docs from existing docstrings; wire into rhiza_book.yml

2 participants