File tree 1 file changed +14
-6
lines changed
1 file changed +14
-6
lines changed Original file line number Diff line number Diff line change @@ -2,21 +2,29 @@ Sphinx Problem Matcher
2
2
======================
3
3
4
4
This action adds a problem matcher that catches Sphinx warnings
5
- to show them neatly inside your pull request like this:
5
+ to show them neatly inside your pull requests.
6
6
7
- .. image :: https://i.imgur.com/xkUMS1a.png
8
- :alt: Example Screenshot
7
+ Usage
8
+ -----
9
9
10
- The common usage of this will be like so:
10
+ We suggest using the action as shown below,
11
+ simply running the action before building your documentation.
12
+
13
+ **Note: This action does not handle actually building your docs. **
11
14
12
15
.. code-block :: yaml
13
16
14
17
- uses : sphinx-doc/github-problem-matcher@master
18
+
15
19
- name : " Build docs"
16
20
run : |
17
21
cd docs
18
22
make html
19
23
20
- That is, simply run this action before building your docs.
24
+ Example
25
+ -------
21
26
22
- **Note: this does not handle actually building your docs. **
27
+ After using the action, files in pull requests will be annotated:
28
+
29
+ .. image :: https://i.imgur.com/xkUMS1a.png
30
+ :alt: Example Screenshot
You can’t perform that action at this time.
0 commit comments