Skip to content

Commit

Permalink
CI: Check ReStructuredText formatting
Browse files Browse the repository at this point in the history
Otherwise, this is only checked after tagging by the PyPI upload.
  • Loading branch information
chrysn committed Jan 14, 2025
1 parent 69f0cf7 commit 1b12d79
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/readme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
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: |
rst2html README.rst >/dev/null

0 comments on commit 1b12d79

Please sign in to comment.