Use UV for CI and docs build

Author: codingjoe

.github/workflows/ci.yml

@@ -5,27 +5,23 @@ on:
       - main
   pull_request:
 jobs:
-  docs:
+  dist:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uvx --from build pyproject-build --sdist --wheel
+      - run: uvx twine check dist/*
+      - uses: actions/upload-artifact@v6
         with:
-          python-version: "3.x"
-      - run: sudo apt install -y python3-enchant graphviz
-      - run: python -m pip install sphinxcontrib-spelling
-      - run: python -m pip install -e '.[docs]'
-      - run: python -m sphinx -W -b spelling docs docs/_build
-  dist:
+          path: dist/*
+  docs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
-        with:
-          python-version: "3.x"
-      - run: python -m pip install --upgrade pip build wheel twine readme-renderer
-      - run: python -m build --sdist --wheel
-      - run: python -m twine check dist/*
+      - run: sudo apt-get install -y gettext graphviz
+      - uses: astral-sh/setup-uv@v7
+      - run: uv run sphinx-build -W -b doctest -b html docs docs/_build
   PyTest:
     needs:
       - dist
@@ -41,29 +37,27 @@ jobs:
         django-version:
           - "5.2"
         extras:
-          - "test"
+          - ""
         include:
           - python-version: "3.x"
             django-version: "5.2"
-            extras: "test,dramatiq"
+            extras: "--extras dramatiq"
           - python-version: "3.x"
             django-version: "5.2"
-            extras: "test,celery"
+            extras: "--extras celery"
           - python-version: "3.x"
             django-version: "5.2"
-            extras: "test,reversion"
+            extras: reversion"
           - python-version: "3.x"
             django-version: "5.2"
-            extras: "test,graphviz,dramatiq"
+            extras: "--extras graphviz,dramatiq"
     steps:
       - uses: actions/checkout@v6
-      - uses: actions/setup-python@v6
+      - run: sudo apt install -y graphviz redis-server
+      - uses: astral-sh/setup-uv@v7
         with:
           python-version: ${{ matrix.python-version }}
-      - run: sudo apt install -y graphviz redis-server
-      - run: python -m pip install "django==${{ matrix.django-version }}.*"
-      - run: python -m pip install -e .[${{ matrix.extras }}]
-      - run: python -m pytest
+      - run: uv run ${{ matrix.extras }} --with Django~=${{ matrix.django-version }}.0 pytest
       - uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -105,3 +105,6 @@ venv.bak/
 
 # flit
 joeflow/_version.py
+
+# uv
+uv.lock

.pre-commit-config.yaml

@@ -47,6 +47,10 @@ repos:
     rev: v1.36.4
     hooks:
       - id: djlint-reformat-django
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.2
+    hooks:
+      - id: sphinx-lint
 ci:
   autoupdate_schedule: weekly
   skip:

.readthedocs.yaml

@@ -3,16 +3,14 @@
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2
 build:
-  os: ubuntu-20.04
-  tools:
-    python: "3.11"
+  os: ubuntu-24.04
   apt_packages:
     - graphviz
-sphinx:
-  configuration: docs/conf.py
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
+  tools:
+    python: "3"
+  jobs:
+    install:
+      - curl -LsSf https://astral.sh/uv/install.sh | sh
+    build:
+      html:
+        - $HOME/.local/bin/uv run sphinx-build -b html docs $READTHEDOCS_OUTPUT/html

MANIFEST.in

@@ -61,7 +61,7 @@ def linkcode_resolve(domain, info):
 master_doc = "index"
 project = "Joeflow"
 
-html_theme = "alabaster"
+html_theme = "furo"
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),

SECURITY.md

@@ -53,6 +53,25 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+graphviz = [
+  "graphviz>=0.18",
+]
+reversion = [
+  "django-reversion",
+]
+celery = [
+  "celery>=4.2.0",
+]
+dramatiq = [
+  "dramatiq>=2.0.0",
+  "django_dramatiq",
+]
+
+[dependency-groups]
+dev = [
+  { include-group = "test" },
+  { include-group = "docs" },
+]
 test = [
   "pytest",
   "pytest-cov",
@@ -61,26 +80,15 @@ test = [
   "redis",
 ]
 docs = [
+  "sphinx",
+  "furo",
   "celery>=4.2.0",
   "django-reversion",
   "dramatiq>=2.0.0",
   "django_dramatiq",
   "redis",
   "graphviz>=0.18",
 ]
-graphviz = [
-  "graphviz>=0.18",
-]
-reversion = [
-  "django-reversion",
-]
-celery = [
-  "celery>=4.2.0",
-]
-dramatiq = [
-  "dramatiq>=2.0.0",
-  "django_dramatiq",
-]
 
 [project.urls]
 Project-URL = "https://github.com/codingjoe/joeflow"