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

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

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