From d3defc52d5379e26443c662e09084bf634e6de51 Mon Sep 17 00:00:00 2001 From: chrysn 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 | 26 ++++++++++++++++++++++++++ 1 file changed, 26 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..586b467 --- /dev/null +++ b/.github/workflows/readme.yml @@ -0,0 +1,26 @@ +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: | + pip install docutils + rst2html README.rst >/dev/null