docs-test.yml

name: docs build

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

jobs:
  docs:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Install pandoc and doxygen
        run: |
          sudo apt install pandoc doxygen

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
          cache: "pip"

      - name: Install dependencies
        run: pip install -r ./requirements.txt

      - name: Install pyro
        run: pip install .

      - name: Build docs
        run: |
          cd docs/
          PYTHONPATH=$GITHUB_WORKSPACE make SPHINXOPTS=-v html

      - name: Check links
        run: |
          cd docs/
          PYTHONPATH=$GITHUB_WORKSPACE make SPHINXOPTS=-v linkcheck