Conversation
…+ docs dep group Co-authored-by: tschm <2046079+tschm@users.noreply.github.com> Agent-Logs-Url: https://github.com/tschm/jquantstats/sessions/9957b64f-2f21-4d16-8fd0-732b318b0951
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
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
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 MkDocs site only had reference pages for
DataandStats, leavingPortfolio,build_data,Plots, andReportsundocumented. Thedocstoolchain also had no declared dependencies, relying entirely on ad-hocuvxinstalls.Changes
New reference pages (
docs/reference/)api.md—build_data()functionportfolio.md—Portfolioclassplots.md—Plotsclassreports.md—Reportsclassdocs/mkdocs.yml— extendednavto 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— addeddocsdependency group (mkdocs,mkdocs-material,mkdocstrings[python]) souv sync --all-groupsinrhiza_book.ymlinstalls them deterministically rather than relying solely on ephemeraluvxresolution.No workflow changes required —
rhiza_book.ymlalready callsmake book→mkdocs-build.Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.