Use UV for CI and docs build

.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 --group docs sphinx-build -W -b doctest -b spelling -b html docs docs/_build
   PyTest:
     needs:
       - dist
@@ -41,29 +37,28 @@ jobs:
         django-version:
           - "5.2"
         extras:
-          - "test"
+          - ""
         include:
-          - python-version: "3.x"
+          - python-version: "3.13"
             django-version: "5.2"
-            extras: "test,dramatiq"
-          - python-version: "3.x"
+            extras: "--extra dramatiq"
+          - python-version: "3.13"
             django-version: "5.2"
-            extras: "test,celery"
-          - python-version: "3.x"
+            extras: "--extra celery"
+          - python-version: "3.13"
             django-version: "5.2"
-            extras: "test,reversion"
-          - python-version: "3.x"
+            extras: "--extra reversion"
+          - python-version: "3.13"
             django-version: "5.2"
-            extras: "test,graphviz,dramatiq"
+            extras: "--extra graphviz --extra 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 }}
+          flags: python-${{ matrix.python-version }}-django-${{ matrix.django-version }}

.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 --group docs sphinx-build -b html docs $READTHEDOCS_OUTPUT/html

README.md

@@ -0,0 +1,20 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://github.com/codingjoe/joeflow/raw/main/docs/images/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://github.com/codingjoe/joeflow/raw/main/docs/images/logo-light.svg">
+    <img alt="Django joeflow: Lean workflow automation for machines with hearts" src="https://github.com/codingjoe/joeflow/raw/main/docs/images/logo-light.svg">
+  </picture>
+<br>
+  <a href="https://joeflow.rtfd.io">Documentation</a> |
+  <a href="https://github.com/codingjoe/joeflow/issues/new/choose">Issues</a> |
+  <a href="https://github.com/codingjoe/joeflow/releases">Changelog</a> |
+  <a href="https://github.com/sponsors/codingjoe">Funding</a> 💚
+</p>
+
+# joeflow
+
+_Lean workflow automation for machines with hearts._
+
+[![version](https://img.shields.io/pypi/v/joeflow.svg)](https://pypi.python.org/pypi/joeflow/)
+[![coverage](https://codecov.io/gh/codingjoe/joeflow/branch/main/graph/badge.svg)](https://codecov.io/gh/codingjoe/joeflow)
+[![license](https://img.shields.io/badge/license-BSD-blue.svg)](https://raw.githubusercontent.com/codingjoe/joeflow/main/LICENSE)

docs/conf.py

@@ -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),

docs/index.rst

@@ -1,11 +1,25 @@
+.. image:: https://github.com/codingjoe/joeflow/raw/main/docs/images/logo-light.svg
+   :align: center
+   :alt: Django joeflow: Lean workflow automation for machines with hearts
+   :class: only-light
+
+.. image:: https://github.com/codingjoe/joeflow/raw/main/docs/images/logo-dark.svg
+   :align: center
+   :alt: Django joeflow: Lean workflow automation for machines with hearts
+   :class: only-dark
+
 =======
 joeflow
 =======
 
-**The lean workflow automation framework for machines with heart.**
+**Lean workflow automation for machines with hearts.**
+
+`Documentation`_ | `Issues`_ | `Changelog`_ | `Funding`_ 💚
 
-.. image:: img/pexels-photo-1020325.jpeg
-   :alt: a hand drawn robot
+.. _documentation: https://joeflow.rtfd.io/
+.. _issues: https://github.com/codingjoe/joeflow/issues/new/choose
+.. _changelog: https://github.com/codingjoe/joeflow/releases
+.. _funding: https://github.com/sponsors/codingjoe
 
 Joeflow is a free workflow automation framework designed to bring simplicity
 to complex workflows. Joeflow written in Python_ based on the world famous