Add documentation scaffolding with MkDocs Material - #68
Open
phinate wants to merge 5 commits into
Open
Conversation
- Remove all [tool.mypy] configuration - Add [tool.ty] configuration with environment, rules, and src settings - ty runs via uvx (not as a project dependency) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Simplify rule selection to core best-practice set - Add target-version templated from min_python_version - Add per-file-ignores for tests - Add isort known-first-party config - Configure format quote-style and indent-style - Remove legacy isort.required-imports and typing-conditional config Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Replace mypy hook with validate-pyproject - Use ruff-check (with --fix) and ruff-format from astral-sh - Add uv-lock hook to keep lockfile in sync - Add note about pending ty pre-commit hook (astral-sh/ty#269) - Add check-toml hook Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
CI: - Split into parallel lint, typecheck, and test jobs - Use astral-sh/setup-uv with caching - Derive Python version matrix from min_python_version - Use uv sync --locked to verify lockfile - Add concurrency group to cancel stale runs CD: - Replace pipx run build with uv build - Update to actions/upload-artifact@v4 and download-artifact@v4 - Simplify to only trigger on release published Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add docs dependency group (mkdocs-material, mkdocstrings) - Add mkdocs.yml with Material theme config - Add placeholder docs/index.md and docs/reference.md - All docs files are conditional on include_docs copier variable Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
phinate
force-pushed
the
pr07-ci-workflows
branch
from
March 19, 2026 13:03
b772fb8 to
18921c6
Compare
phinate
force-pushed
the
pr08-docs-scaffolding
branch
from
March 19, 2026 13:03
15cf9e3 to
9a066fb
Compare
phinate
force-pushed
the
pr07-ci-workflows
branch
3 times, most recently
from
March 20, 2026 15:39
e8dea74 to
5d2133a
Compare
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
docsdependency group:mkdocs-material>=9.0,mkdocstrings[python]>=0.27mkdocs.ymlwith Material theme, search, and mkdocstrings plugindocs/index.mdanddocs/reference.md(auto-generated API docs)include_docsCopier variableTest plan
uv sync --group docs && uv run mkdocs servestarts a local dev server without errorsuv run mkdocs build --strictbuilds the site without warnings__init__.pydocstring on the reference pageinclude_docs: falsein Copier answers excludes all docs files and the docs dependency group🤖 Generated with Claude Code