Repository navigation
Add mkdocs documentation site, deployed to GitHub Pages - #1
Merged
Merged
Conversation
mkdocs-material + mkdocstrings, following the same pattern as MarkoWizard: build via uv on push to main, deploy through actions/deploy-pages. Docs cover installation, a quick-start, and a full API reference generated from the existing docstrings. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
docs.yml(uv build →actions/deploy-pages) on push tomainTest plan
mkdocs build --strictsucceeds locally with no warnings/errorsruff check ./ruff format --check .passdocs.ymlworkflow succeeds after merge and the site is live at https://outliersanalytics.github.io/statsjunk/🤖 Generated with Claude Code