Skip to content

Commit

Permalink
Add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ammaraskar committed Feb 16, 2020
1 parent c7577e3 commit 1844166
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# sphinx-problem-matcher
Github Action problem matcher for the Sphinx documentation tool

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

![Example Screenshot](https://i.imgur.com/xkUMS1a.png)

The common usage of this will be like so:

```yaml
- 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.**

0 comments on commit 1844166

Please sign in to comment.