Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)


<!-- Do not edit anything below this. -->

## 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`)
5 changes: 2 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ build:

python:
install:
- method: pip
path: .
extra_requirements:
- docs
- method: uv
command: sync
extras:
- docs
Comment thread
cursor[bot] marked this conversation as resolved.
Loading