Skip to content

Merge pull request #870 from cweikl/master #362

Merge pull request #870 from cweikl/master

Merge pull request #870 from cweikl/master #362

Workflow file for this run

# This is a basic workflow to help you get started with Actions
name: VerifyDocs
# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ master ]
pull_request:
branches: [ master ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# 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-20.04
# 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
- name: Sphinx Build
# You may pin to the exact commit or the version.
# uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2
uses: ammaraskar/sphinx-action@master
with:
# The folder containing your sphinx docs.
docs-folder: "./" # default is docs/
# The command used to build your documentation.
build-command: "sphinx-build -nW -b html -d build/doctrees source build/html" # optional, default is make html
# Run before the build command, you can use this to install system level dependencies, for example with "apt-get update -y && apt-get install -y perl"
# pre-build-command: # optional