fix: restore docs deploy and fix PyPI badge - #37
Merged
Conversation
- Add mkdocs.yml (was never committed; MkDocs was run manually in 2020) Uses mkdocs-material theme and mkdocstrings for the API reference pages. - Add .github/workflows/docs.yml that builds and deploys to gh-pages on every push to main via mkdocs gh-deploy. - Switch PyPI badge from badge.fury.io (stale) to shields.io which pulls the live version from PyPI on every page load. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
=======================================
Coverage 91.61% 91.61%
=======================================
Files 7 7
Lines 787 787
=======================================
Hits 721 721
Misses 66 66 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Changed claude-code-review.yml from firing on every PR open/sync to workflow_dispatch only. Reviews can still be triggered two ways: - Comment @claude on any PR (handled by claude.yml) - Actions → Claude Code Review → Run workflow → enter PR number Co-Authored-By: Claude Sonnet 4.6 <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
badge.fury.io(was stuck showing 0.1.6) toshields.io/pypi/v/yamldoc, which pulls the live version on every page load.mkdocs.ymlconfig was never committed — docs were deployed manually in 2020 and never touched again. This PR adds it along with a workflow that auto-deploys on every push tomain.What's in mkdocs.yml
mkdocs-material(modern look, responsive)mkdocstrings[python]for the API reference pages (docs/api/classes.mdanddocs/api/main.mdwere already using:::syntax, just had no config)Test plan
mkdocs buildruns successfully locally (warnings are about missing type annotations in existing code, not errors)deploy-docsworkflow fires and the gh-pages branch updateshttps://chris1221.github.io/yamldoc/renders correctly after deploy🤖 Generated with Claude Code