docs.yml

# This workflow will install Python dependencies, run tests, run linting, and test building docs
name: Building Docs

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        platform: ["ubuntu-latest"]
        python-version: ["3.10"]
    defaults:
      run:
        shell: bash
    runs-on: ${{ matrix.platform }}
    steps:
        - uses: actions/checkout@v2
        - name: Set up Python ${{ matrix.python-version }}
          uses: actions/setup-python@v2
          with:
            python-version: ${{ matrix.python-version }}
        - name: Install dependencies
          run: |
            pip install pip setuptools wheel --upgrade
            python -m pip install -e '.[docs]'
        - name: Build docs
          run: |
            sphinx-build docs docs/_build/html -b html