-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c7577e3
commit 1844166
Showing
1 changed file
with
19 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,20 @@ | ||
# sphinx-problem-matcher | ||
Github Action problem matcher for the Sphinx documentation tool | ||
|
||
This action adds a problem matcher that catches Sphinx warnings to show them | ||
neatly inside your pull request like this: | ||
|
||
![Example Screenshot](https://i.imgur.com/xkUMS1a.png) | ||
|
||
The common usage of this will be like so: | ||
|
||
```yaml | ||
- uses: ammaraskar/sphinx-problem-matcher@master | ||
- name: "Build docs" | ||
run: | | ||
cd docs | ||
make html | ||
``` | ||
That is, simply run this action before building your docs. | ||
**Note: this does not handle actually building your docs.** |