diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 749641af..5a42c81b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,4 +7,9 @@ ## Additional Context for Reviewers -- [ ] I passed tests locally for both code (`uv run pytest`) and documentation changes (`uv run jb build docs --builder=custom --custom-builder=doctest`) + + + + +## Checklist +- [ ] I passed tests locally for both code (`uv run pytest`) and documentation changes (`uv run --directory docs jb build . --builder=custom --custom-builder=doctest`) diff --git a/docs/README.md b/docs/README.md index 8ae43361..00fcb162 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,9 +9,8 @@ If you only want to read the docs, use the published site. This README is for co From the repository root: ```bash -pip install -e .[docs] -cd docs -jb build . +uv sync --extra docs +uv run --directory docs jb build . ``` The rendered site is written to `docs/_build/html/`. Open `docs/_build/html/index.html` in a browser to review changes. diff --git a/readthedocs.yaml b/readthedocs.yaml index bcb94429..1b4fe37f 100644 --- a/readthedocs.yaml +++ b/readthedocs.yaml @@ -14,7 +14,7 @@ build: python: install: - - method: pip - path: . - extra_requirements: - - docs \ No newline at end of file + - method: uv + command: sync + extras: + - docs