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