Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 646 Bytes

README.rst

File metadata and controls

30 lines (20 loc) · 646 Bytes

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