Update doc builds for uv

This fully ties the document building to uv by instructing the user to
build a virtual environment with uv.

This also allows us to remove the requirements.txt, as everything should
run through the pyproject.toml.

Author: hinerm

.readthedocs.yaml

@@ -20,4 +20,7 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: doc/requirements.txt
+   - method: pip
+     path: .
+     extra_requirements:
+     - dev

Makefile

@@ -20,7 +20,7 @@ test: check
 	bin/test.sh
 
 docs:
-	cd doc && $(MAKE) html
+	uv run make -C doc html
 
 dist: check clean
 	uv run python -m build

doc/Development.md

@@ -27,15 +27,23 @@ If you are testing a project that *uses* `pyimagej` and need to see how changes
 
 ## Building the reference documentation
 
-PyImageJ documentation is built as a [Sphinx](https://www.sphinx-doc.org/en/master/)-built [ReadTheDocs](https://about.readthedocs.com/) site. The documentation has its own `Makefile` in the `/docs` directory. From there:
+PyImageJ documentation is built as a [Sphinx](https://www.sphinx-doc.org/en/master/)-built [ReadTheDocs](https://about.readthedocs.com/) site.
 
+To build the documentation, **you must create a `uv` virtual environment** with the additional development dependencies:
+
+```bash
+uv run pip install -e ".[dev]"
 ```
+
+Then, you can either use the documentation's own `Makefile` in the `/docs` directory:
+
+```bash
 make html
 ```
 
-Alternatively, from the project root:
+Alternatively, from the project root `Makefile`:
 
-```
+```bash
 make docs
 ```
 
@@ -45,18 +53,18 @@ Production documentation is available online at
 
 ## Running the automated tests
 
-```
+```bash
 make test
 ```
 
 ## Formatting the code
 
-```
+```bash
 make lint
 ```
 
 ## Building distribution bundles
 
-```
+```bash
 make dist
 ```

doc/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   ?= uv run sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

doc/requirements.txt

@@ -52,7 +52,9 @@ dev = [
     "pytest",
     "ruff",
     "sphinx",
+    "sphinx-copybutton",
     "sphinx_rtd_theme",
+    "readthedocs-sphinx-search",
     "validate-pyproject[all]",
 ]