Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book

GitHub Action

Sphinx Problem Matcher

0.1

Sphinx Problem Matcher

book

Sphinx Problem Matcher

Attaches a problem matcher that looks for errors during Sphinx builds

Installation

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

              

- name: Sphinx Problem Matcher

uses: sphinx-doc/[email protected]

Learn more about this action in sphinx-doc/github-problem-matcher

Choose a version

sphinx-problem-matcher

This action adds a problem matcher that catches Sphinx warnings to show them neatly inside your pull request like this:

Example Screenshot

The common usage of this will be like so:

    - uses: ammaraskar/sphinx-problem-matcher@master
    - name: "Build docs"
      run: |
        cd docs
        make html

That is, simply run this action before building your docs.

Note: this does not handle actually building your docs.