Skip to content

Commit 1f74d65

Browse files
committed
Move usage instructions above the fold
1 parent d64430c commit 1f74d65

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,29 @@ Sphinx Problem Matcher
22
======================
33

44
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.
66

7-
.. image:: https://i.imgur.com/xkUMS1a.png
8-
:alt: Example Screenshot
7+
Usage
8+
-----
99

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.**
1114

1215
.. code-block:: yaml
1316
1417
- uses: sphinx-doc/github-problem-matcher@master
18+
1519
- name: "Build docs"
1620
run: |
1721
cd docs
1822
make html
1923
20-
That is, simply run this action before building your docs.
24+
Example
25+
-------
2126

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

0 commit comments

Comments
 (0)