Skip to content

Github Action problem matcher for the Sphinx documentation tool

License

Notifications You must be signed in to change notification settings

sphinx-doc/github-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

18 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx Problem Matcher

This action adds a problem matcher that catches Sphinx warnings to show them neatly inside your pull requests.

Usage

We suggest using the action as shown below, simply running the action before building your documentation.

Note: This action does not handle actually building your docs.

- uses: sphinx-doc/github-problem-matcher@master

- name: "Build docs"
  run: |
    cd docs
    make html

Example

After using the action, files in pull requests will be annotated:

Example Screenshot

About

Github Action problem matcher for the Sphinx documentation tool

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •