Convert README to reStructuredText

sphinx-doc · Dec 25, 2023 · 5e1517d · 5e1517d
1 parent 9145239
commit 5e1517d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 20 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,22 @@
+Sphinx Problem Matcher
+======================
+
+This action adds a problem matcher that catches Sphinx warnings
+to show them neatly inside your pull request like this:
+
+.. image:: https://i.imgur.com/xkUMS1a.png
+   :alt: Example Screenshot
+
+The common usage of this will be like so:
+
+.. 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.
+
+**Note: this does not handle actually building your docs.**