https://github.com/rffontenelle/sphinx-lint-problem-matcher

GitHub Action problem matcher for the Sphinx Lint
https://github.com/rffontenelle/sphinx-lint-problem-matcher

Last synced: about 1 month ago
JSON representation

GitHub Action problem matcher for the Sphinx Lint

• Host: GitHub
• URL: https://github.com/rffontenelle/sphinx-lint-problem-matcher
• Owner: rffontenelle
• License: bsd-2-clause
• Created: 2023-12-23T02:11:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-07T23:14:35.000Z (8 months ago)
• Last Synced: 2024-11-13T07:46:44.328Z (about 2 months ago)
• Size: 77.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sphinx-lint-problem-matcher

[![Test workflow status badge](https://github.com/rffontenelle/sphinx-lint-problem-matcher/actions/workflows/test.yml/badge.svg)](https://github.com/rffontenelle/sphinx-lint-problem-matcher/actions/workflows/test.yml)

This action adds a GitHub Action problem matcher that annotates messages

printed by [sphinx-lint][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:

```yaml

    - uses: rffontenelle/sphinx-lint-problem-matcher@v1

    - run: sphinx-lint docs/*.rst

```

## Acknowledgement

Inspired by Sphinx's [github-problem-matcher][sphinx-gpm], created by Ammar Askar.

[sphinx-lint]: https://github.com/sphinx-contrib/sphinx-lint

[sphinx-gpm]: https://github.com/sphinx-doc/github-problem-matcher