docs: add mkdocs-material site with GH Pages deploy#122
Merged
Conversation
Add MkDocs Material documentation site targeting https://opendecree.github.io/decree-python. - mkdocs.yml with Material theme (teal/cyan palette), mkdocstrings plugin, nav structure - docs/index.md: intro, install, quick start, examples table - docs/guide/connect.md: all client options (auth, TLS, retry, timeouts, OTel, errors) - docs/guide/watch.md: watcher lifecycle, WatchedField API, async, fork safety - docs/api/index.md: auto-generated reference via mkdocstrings for all public classes and errors - .github/workflows/docs.yml: builds and deploys to GH Pages on push to main and version tags - sdk/pyproject.toml: adds docs optional-dependencies group, updates Documentation URL - README.md: adds docs badge linking to the site Closes #8 Co-Authored-By: Claude <noreply@anthropic.com>
zeevdr
added
size: M
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
Test plan
pip install mkdocs-material mkdocstrings[python] && mkdocs buildruns clean from repo rootmkdocs serverenders all four pages (Home, Connecting, Watching, API Reference) without errorsopendecree.ConfigClient,AsyncConfigClient,ConfigWatcher,WatchedField, error classes, and data typesCloses #8