docs.yml

name: generate Documentation

on: [push, pull_request]

jobs:
  build:
    runs-on: ubuntu-20.04

    strategy:
      max-parallel: 4
      matrix:
        python-version: [3.8]

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}

      - name: Give permission to run scripts
        run: chmod +x ./docs/scripts/doc8_style_check.sh

      - name: Install Dependencies
        working-directory: ./docs
        run:  pip install -r requirements.txt

      - name: Check Sphinx Documentation build minimally
        working-directory: ./docs
        run: sphinx-build -b linkcheck -EW source build

      - name: Check for documentation style errors
        working-directory: ./docs
        run: ./scripts/doc8_style_check.sh