Skip to content

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: Build Sphinx Documentation
# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
on: [push, pull_request]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v2
# Run a sphinx build test
- name: Sphinx Build
uses: ammaraskar/[email protected]
with:
# The folder containing your sphinx docs.
docs-folder: "docs/sphinx/" # default is docs/
# The command used to build your documentation.
build-command: make html # optional, default is make html
# Pre-build command
pre-build-command: "apt-get update -y && apt-get install -y gcc && pip install .[docs]"