Add MkDocs documentation site and complete docstring coverage - #551
Merged
Conversation
Adds a MkDocs + Material + mkdocstrings site (docs/) with an API reference generated from docstrings and two runnable tutorials (CPTAC lung cancer clustering, EBDT kinase-inhibitor clustering), published to GitHub Pages via a new Actions workflow on every push to main. Also fills in missing docstrings across the core library and figures/common.py: every function/method now has a purpose description plus documented arguments and return values, and every module has a top-of-file summary of its contents. Adds a handful of type annotations needed for strict docstring builds, with matching @overload signatures where a plain annotation lost ty's per-call return-type narrowing. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CQsZJTWRf2sCC9hVH5Zv2Y
Neither package is referenced anywhere in the codebase; dropping them also removes their transitive dependencies (anyio, httpx, httpcore, h11, biothings-client) from the lockfile. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CQsZJTWRf2sCC9hVH5Zv2Y
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.
Adds a MkDocs + Material + mkdocstrings site (docs/) with an API reference generated from docstrings and two runnable tutorials (CPTAC lung cancer clustering, EBDT kinase-inhibitor clustering), published to GitHub Pages via a new Actions workflow on every push to main.
Also fills in missing docstrings across the core library and figures/common.py: every function/method now has a purpose description plus documented arguments and return values, and every module has a top-of-file summary of its contents. Adds a handful of type annotations needed for strict docstring builds, with matching @overload signatures where a plain annotation lost ty's per-call return-type narrowing.
Claude-Session: https://claude.ai/code/session_01CQsZJTWRf2sCC9hVH5Zv2Y