34 lines
1.1 KiB
YAML
34 lines
1.1 KiB
YAML
|
# This is a basic workflow to help you get started with Actions
|
||
|
|
|
||
|
|
name: Documentation build
|
||
|
|
|
||
|
|
# Controls when the action will run. Triggers the workflow on push or pull request
|
||
|
|
# events but only for the master branch
|
||
|
|
on:
|
||
|
|
push:
|
||
|
|
branches: [ master ]
|
||
|
|
pull_request:
|
||
|
|
branches: [ master ]
|
||
|
|
|
||
|
|
# 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
|
||
|
|
|
||
|
|
- name: Sphinx Build
|
||
|
|
# You may pin to the exact commit or the version.
|
||
|
|
# uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2
|
||
|
|
uses: ammaraskar/sphinx-action@0.4
|
||
|
|
with:
|
||
|
|
# The folder containing your sphinx docs.
|
||
|
|
docs-folder: doc/
|
||
|
|
# The command used to build your documentation.
|
||
|
|
build-command: make html
|