Add mkdocs documentation - #3
Merged
Merged
Conversation
Adds an mkdocs-material site with an API reference (mkdocstrings) for every public module, matching the docs setup used across other meyer-lab Python repos (RISE, DDMC, parafac2). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DCdnqsvzruAac1NCN9Thic
4 tasks
Builds the mkdocs site on push to main and uploads it as a Pages artifact (actions/upload-pages-artifact + deploy-pages), not a gh-pages branch, matching the pattern used by RISE/DDMC/parafac2. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DCdnqsvzruAac1NCN9Thic
Member
Author
|
@copilot resolve the merge conflicts in this pull request |
# Conflicts: # pyproject.toml # uv.lock Co-authored-by: aarmey <2065146+aarmey@users.noreply.github.com>
Co-authored-by: aarmey <2065146+aarmey@users.noreply.github.com>
Contributor
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.
Summary
resample,procedures,seeds,store,query,uq,optimism)docsdependency group topyproject.toml(mkdocs, mkdocs-material, mkdocstrings[python])No GitHub Pages deploy workflow is included here — the org's standard test/lint action is being added in a separate PR.
Test plan
uv sync --group docsuv run mkdocs build --strictsucceeds with no warnings/errors🤖 Generated with Claude Code
https://claude.ai/code/session_01DCdnqsvzruAac1NCN9Thic