From bf4066eec3a172309f05475245685dd1bd5230ef Mon Sep 17 00:00:00 2001
From: chrysn <chrysn@fsfe.org>
Date: Tue, 14 Jan 2025 14:06:29 +0100
Subject: [PATCH] CI: Check ReStructuredText formatting

Otherwise, this is only checked after tagging by the PyPI upload.
---
 .github/workflows/readme.yml | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 .github/workflows/readme.yml

diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml
new file mode 100644
index 0000000..2fa633c
--- /dev/null
+++ b/.github/workflows/readme.yml
@@ -0,0 +1,27 @@
+name: README Lints
+
+# This matches the Maturin rules
+
+on:
+  push:
+    branches:
+      - main
+      - master
+    tags:
+      - '*'
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  rst:
+    name: Validate README
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+
+      - name: "Run rst2html"
+        run: |
+          set -e
+          pip install docutils
+          rst2html --exit 2 README.rst >/dev/null