Skip to content

Sphinx Lint Problem Matcher

Actions
Attaches a problem matcher that looks for errors reported during sphinx-lint runs
v1.0.0
Latest
Star (2)

sphinx-lint-problem-matcher

Test workflow status badge

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:

Usage

Set to use this workflow before running sphinx-lint. For instance:

    - uses: rffontenelle/sphinx-lint-problem-matcher@v1
    - run: sphinx-lint docs/*.rst

Acknowledgement

Inspired by Sphinx's github-problem-matcher, created by Ammar Askar.

Sphinx Lint Problem Matcher is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Attaches a problem matcher that looks for errors reported during sphinx-lint runs
v1.0.0
Latest

Sphinx Lint Problem Matcher is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.