{"repo":"ammaraskar/sphinx-action","free":true,"listed":false,"github":"https://github.com/ammaraskar/sphinx-action","clone":"git clone https://github.com/ammaraskar/sphinx-action.git","description":"Github action that builds docs using sphinx and places errors inline","language":"Python","stars":209,"topics":["github-actions","github-action","sphinx","status-check"],"license":"Apache-2.0","category":"workflow-automation","readme_excerpt":"Sphinx Build Action 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. How to use Create a workflow for the action, for example: You can choose a Sphinx version by using the appropriate tag. For example, to specify Sphinx 7.0.0 you would use ammaraskar/sphinx-action@7.0.0 . master currently uses Sphinx 2.4.4. If you have any Python dependencies that your project needs (themes, build tools, etc) then place them in a requirements.txt file inside your docs folder. If you have multiple sphinx documentation folders, please use multiple uses blocks. For a full example repo using this action including advanced usage, take a look at https://github.com/ammaraskar/sphinx-action-test Great Actions to Pair With Some really good actions that work well with this one are actions/upload-artifact and ad-m/github-push-action . You can use these to make built HTML and PDFs available as artifacts: Or to push docs changes automatically to a gh-pages branch: Code for your workflow For a full fledged example of this in action take a look at: https://github.com/ammaraskar/sphinx-action-test Advanced Usage If you wish to customize ","default_branch":null,"files":null,"tree":[],"storefront":"/r/ammaraskar","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ammaraskar/sphinx-action/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}