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 9145239 commit 5e1517dCopy full SHA for 5e1517d
README.md
README.rst
@@ -0,0 +1,22 @@
1
+Sphinx Problem Matcher
2
+======================
3
+
4
+This action adds a problem matcher that catches Sphinx warnings
5
+to show them neatly inside your pull request like this:
6
7
+.. image:: https://i.imgur.com/xkUMS1a.png
8
+ :alt: Example Screenshot
9
10
+The common usage of this will be like so:
11
12
+.. code-block:: yaml
13
14
+ - uses: sphinx-doc/github-problem-matcher@master
15
+ - name: "Build docs"
16
+ run: |
17
+ cd docs
18
+ make html
19
20
+That is, simply run this action before building your docs.
21
22
+**Note: this does not handle actually building your docs.**
0 commit comments