# 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 "docs"
  docs:
    # 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:
      - uses: actions/checkout@v2.3.5
        with:
          submodules: 'recursive'
      - name: Install packages
        run:
          sudo apt-get update -y &&
          sudo apt-get install -y git python3-sphinx graphviz libenchant1c2a &&
          sudo pip install tox
      - name: Test doc build
        run: tox -e docs