This action adds a problem matcher that catches Sphinx warnings to show them neatly inside your pull request like this:
The common usage of this will be like so:
- uses: sphinx-doc/github-problem-matcher@master
- name: "Build docs"
run: |
cd docs
make htmlThat is, simply run this action before building your docs.
Note: this does not handle actually building your docs.