docs.yml

name: docs

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

jobs:
  test-ubuntu:
    name: "docs on ${{ matrix.python-version }} on ${{ matrix.os }}"
    runs-on: "${{ matrix.os }}"
    strategy:
      matrix:
        python-version: ["3.10"]
        os: [ubuntu-latest]
    steps:
      - uses: actions/checkout@v2
      - name: Set up Python ${{ matrix.python-version }}
        uses: actions/setup-python@v1
        with:
          python-version: ${{ matrix.python-version }}
      - name: Install dependencies
        run: |
          sudo apt install graphviz
          sudo apt install -y pandoc
          python -m pip install --upgrade pip
          pip install .
          pip install -r docs/requirements.txt
      - name: Test doctests
        run: |
          cd docs
          make doctest
      - name: Test docs to HTML
        run: |
          cd docs
          make html