This is a Github action that looks for Sphinx documentation folders in your project. It builds the documentation using Sphinx and any errors in the build process are bubbled up as Github status checks.
The main purposes of this action are:
-
Run a CI test to ensure your documentation still builds.
-
Allow contributors to get build errors on simple doc changes inline on Github without having to install Sphinx and build locally.