Skip to content

Commit

Permalink
Move usage instructions above the fold
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Dec 26, 2023
1 parent d64430c commit 1f74d65
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,29 @@ Sphinx Problem Matcher
======================

This action adds a problem matcher that catches Sphinx warnings
to show them neatly inside your pull request like this:
to show them neatly inside your pull requests.

.. image:: https://i.imgur.com/xkUMS1a.png
:alt: Example Screenshot
Usage
-----

The common usage of this will be like so:
We suggest using the action as shown below,
simply running the action before building your documentation.

**Note: This action does not handle actually building your docs.**

.. code-block:: yaml
- uses: sphinx-doc/github-problem-matcher@master
- name: "Build docs"
run: |
cd docs
make html
That is, simply run this action before building your docs.
Example
-------

**Note: this does not handle actually building your docs.**
After using the action, files in pull requests will be annotated:

.. image:: https://i.imgur.com/xkUMS1a.png
:alt: Example Screenshot

0 comments on commit 1f74d65

Please sign in to comment.