Skip to content
book

GitHub Action

Sphinx Lint Problem Matcher

v1.0.0 Latest version

Sphinx Lint Problem Matcher

book

Sphinx Lint Problem Matcher

Attaches a problem matcher that looks for errors reported during sphinx-lint runs

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Sphinx Lint Problem Matcher

uses: rffontenelle/[email protected]

Learn more about this action in rffontenelle/sphinx-lint-problem-matcher

Choose a version

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.