Skip to content

Commit 5e1517d

Browse files
committed
Convert README to reStructuredText
1 parent 9145239 commit 5e1517d

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

README.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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

Comments
 (0)