Awesome Open Source
Awesome Open Source

Sphinx Build Action

Build Status Test Coverage

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.

Example Screenshot

How to use

Create a workflow for the action, for example:

name: "Pull Request Docs Check"
- pull_request

    runs-on: ubuntu-latest
    - uses: actions/[email protected]
    - uses: ammaraskar/[email protected]
        docs-folder: "docs/"
  • 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

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:

    - uses: actions/[email protected]
        name: DocumentationHTML
        path: docs/_build/html/

Or to push docs changes automatically to a gh-pages branch:

Code for your workflow

    - name: Commit documentation changes
      run: |
        git clone --branch gh-pages --single-branch gh-pages
        cp -r docs/_build/html/* gh-pages/
        cd gh-pages
        git config --local "[email protected]"
        git config --local "GitHub Action"
        git add .
        git commit -m "Update documentation" -a || true
        # The above command will fail if no changes were present, so we ignore
        # the return code.
    - name: Push changes
      uses: ad-m/[email protected]
        branch: gh-pages
        directory: gh-pages
        github_token: ${{ secrets.GITHUB_TOKEN }}

For a full fledged example of this in action take a look at:

Advanced Usage

If you wish to customize the command used to build the docs (defaults to make html), you can provide a build-command in the with block. For example, to invoke sphinx-build directly you can use:

    - uses: ammaraskar/[email protected]
        docs-folder: "docs/"
        build-command: "sphinx-build -b html . _build"

If there's system level dependencies that need to be installed for your build, you can use the pre-build-command argument like so:

    - uses: ammaraskar/[email protected]
        docs-folder: "docs2/"
        pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
        build-command: "make latexpdf"

Running the tests

python -m unittest


Please use black for formatting:

black sphinx_action tests

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
python (54,523
github-actions (248
github-action (57
sphinx (46