Describe developer setup in more detail

README.md

@@ -58,7 +58,7 @@ git fetch --tags upstream
 Then install:
 
 ```sh
-pip install -e ".[dev,test]"
+pip install -e ".[dev,test,doc]"
 ```
 
 Additionally, you can install pre-commit hooks which will automatically reformat and lint the code when you make a commit:
@@ -69,3 +69,14 @@ pre-commit install
 # To disable:
 # pre-commit uninstall
 ```
+
+Tests should now pass:
+
+```sh
+make check-tests
+make check-types
+make check-lint
+make check-format
+```
+
+See the [docs README](docs/README.md) for instructions on building the documentation locally.

docs/README.md

@@ -5,7 +5,7 @@ This directory contains files to generate Shiny for Python API documentation, us
 
 ## Building the docs
 
-To build the docs, first install the Python dependencies and Quarto extensions:
+To build the docs, first [download and install Quarto](https://quarto.org/docs/get-started/), and then install the Python dependencies and Quarto extensions:
 
 ```bash
 # Install build dependencies
@@ -22,6 +22,7 @@ Then build the web site using Quarto:
 
 ```bash
 make site
+# When this completes, the docs will be available at _site/index.html.
 ```
 
 Alternatively, running `make serve` will build the docs, and serve them locally, and watch for changes to the .qmd files:

pyproject.toml

@@ -117,7 +117,7 @@ dev = [
     "google-generativeai;python_version>='3.9'",
     "langchain_core",
     # langsmith (needed for langchain_core) versions >= 0.3
-    # (up to at least 0.3.2 as of 2025-01-29) 
+    # (up to at least 0.3.2 as of 2025-01-29)
     # cause an `argparse.ArgumentError` when running `pytest`.
     # https://github.com/posit-dev/py-shiny/issues/1829
     "langsmith<0.3",
@@ -126,6 +126,7 @@ dev = [
     "tokenizers",
     "aiohttp",
     "beautifulsoup4",
+    "uv",
 ]
 doc = [
     "jupyter",