https://github.com/sphinx-doc/github-problem-matcher

Github Action problem matcher for the Sphinx documentation tool
https://github.com/sphinx-doc/github-problem-matcher

Last synced: 8 months ago
JSON representation

Github Action problem matcher for the Sphinx documentation tool

• Host: GitHub
• URL: https://github.com/sphinx-doc/github-problem-matcher
• Owner: sphinx-doc
• License: other
• Created: 2020-02-16T09:04:50.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-26T02:31:42.000Z (about 2 years ago)
• Last Synced: 2025-04-08T12:02:14.461Z (9 months ago)
• Language: JavaScript
• Size: 23.4 KB
• Stars: 12
• Watchers: 4
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

          
Sphinx Problem Matcher

======================

This action adds a problem matcher that catches Sphinx warnings

to show them neatly inside your pull requests.

Usage

-----

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

Example

-------

After using the action, files in pull requests will be annotated:

.. image:: https://i.imgur.com/xkUMS1a.png

   :alt: Example Screenshot