This action adds a GitHub Action problem matcher that annotates messages printed by sphinx-lint, making it easier to spot Sphinx syntax errors.
How it shows up in the summary page of a GitHub Action run:
How it shows up in pull requests, in the "Files changed" tab:
Set to use this workflow before running sphinx-lint
. For instance:
- uses: rffontenelle/sphinx-lint-problem-matcher@v1
- run: sphinx-lint docs/*.rst
Inspired by Sphinx's github-problem-matcher, created by Ammar Askar.