We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent c7577e3 commit 1844166Copy full SHA for 1844166
README.md
@@ -1,2 +1,20 @@
1
# sphinx-problem-matcher
2
-Github Action problem matcher for the Sphinx documentation tool
+
3
+This action adds a problem matcher that catches Sphinx warnings to show them
4
+neatly inside your pull request like this:
5
6
+
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