Modernise CI + CONTRIBUTING + docstack

Author: patrick-kidger

.github/workflows/release.yml

@@ -29,14 +29,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release
-        uses: patrick-kidger/action_update_python_project@v6
+        uses: patrick-kidger/action_update_python_project@v8
         with:
             python-version: "3.11"
             test-script: |
-                python -m pip install .[tests]
-                python -m pip install torch --extra-index-url https://download.pytorch.org/whl/cpu
                 cp -r ${{ github.workspace }}/test ./test
-                pytest
+                cp ${{ github.workspace }}/pyproject.toml ./pyproject.toml
+                uv sync --extra tests --no-install-project --inexact
+                uv pip install torch --extra-index-url https://download.pytorch.org/whl/cpu
+                uv run --no-sync pytest
             pypi-token: ${{ secrets.pypi_token }}
             github-user: patrick-kidger
             github-token: ${{ github.token }}

.github/workflows/run_tests.yml

@@ -42,13 +42,17 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install .[tests]
+          python -m pip install '.[dev,docs,tests]'
           python -m pip install torch --extra-index-url https://download.pytorch.org/whl/cpu
 
       - name: Checks with pre-commit
-        uses: pre-commit/action@v3.0.1
+        run: |
+          pre-commit run --all-files
 
       - name: Test with pytest
         run: |
-          python -m pip install .
-          python -m pytest --durations=0
+          pytest
+
+      - name: Check that documentation can be built.
+        run: |
+          mkdocs build

CONTRIBUTING.md

@@ -4,33 +4,32 @@ Contributions (pull requests) are very welcome! Here's how to get started.
 
 ---
 
+**Getting started**
+
 First fork the library on GitHub.
 
-Then clone and install the library in development mode:
+Then clone and install the library:
 
 ```bash
 git clone https://github.com/your-username-here/jaxtyping.git
 cd jaxtyping
-pip install -e .
+pip install -e '.[dev]'
+pre-commit install  # `pre-commit` is installed by `pip` on the previous line
 ```
 
-Then install the pre-commit hook:
-
-```bash
-pip install pre-commit
-pre-commit install
-```
+---
 
-These hooks use ruff to lint and format the code.
+**If you're making changes to the code:**
 
 Now make your changes. Make sure to include additional tests if necessary.
 
 Next verify the tests all pass:
 
 ```bash
-pip install -e .[tests]
+pip install -e '.[tests]'
+# The torch line might need adjusting depending on your operating system, see https://pytorch.org
 pip install torch --extra-index-url https://download.pytorch.org/whl/cpu
-pytest
+pytest  # `pytest` is installed by `pip` on the previous line.
 ```
 
 Then push your changes back to your fork of the repository:
@@ -40,3 +39,16 @@ git push
 ```
 
 Finally, open a pull request on GitHub!
+
+---
+
+**If you're making changes to the documentation:**
+
+Make your changes. You can then build the documentation by doing
+
+```bash
+pip install -e '.[docs]'
+mkdocs serve
+```
+
+You can then see your local copy of the documentation by navigating to `localhost:8000` in a web browser.

pyproject.toml

@@ -31,12 +31,14 @@ dev = [
   "pre-commit>=4.3.0",
 ]
 docs = [
-  "hippogriffe==0.2.0",
+  "hippogriffe==0.2.1",
+  "griffe==1.7.3",
   "mkdocs==1.6.1",
   "mkdocs-include-exclude-files==0.1.0",
-  "mkdocs-ipynb==0.1.0",
+  "mkdocs-ipynb==0.1.1",
   "mkdocs-material==9.6.7",
-  "mkdocstrings[python]==0.28.3",
+  "mkdocstrings==0.28.3",
+  "mkdocstrings-python==1.16.8",
   "pymdown-extensions==10.14.3",
 ]
 tests = [
@@ -50,7 +52,7 @@ tests = [
     "pytest>=8.4.2",
     "pytest-asyncio>=1.2.0",
     "tensorflow>=2.18.1",
-    "typeguard<3",
+    "typeguard==2.13.3",
 ]