Skip to content

rffontenelle/sphinx-lint-problem-matcher

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

GitHub Action problem matcher for the Sphinx Lint

Resources

License

Stars

Watchers

Forks

Packages

No packages published