Skip to content

Commit 1844166

Browse files
committed
Add some documentation
1 parent c7577e3 commit 1844166

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,20 @@
11
# sphinx-problem-matcher
2-
Github Action problem matcher for the Sphinx documentation tool
2+
3+
This action adds a problem matcher that catches Sphinx warnings to show them
4+
neatly inside your pull request like this:
5+
6+
![Example Screenshot](https://i.imgur.com/xkUMS1a.png)
7+
8+
The common usage of this will be like so:
9+
10+
```yaml
11+
- uses: ammaraskar/sphinx-problem-matcher@master
12+
- name: "Build docs"
13+
run: |
14+
cd docs
15+
make html
16+
```
17+
18+
That is, simply run this action before building your docs.
19+
20+
**Note: this does not handle actually building your docs.**

0 commit comments

Comments
 (0)