documentation-ci.yml

name: Documentation CI

on:
  pull_request:
    branches: [ "master" ]
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

permissions:
  contents: read
  id-token: write

jobs:

  linux-ci-doc:
    runs-on: ubuntu-latest
    timeout-minutes: 180
    env:
      MPIEXEC_FLAGS: "--allow-run-as-root --oversubscribe"
      PYNUCLEUS_BUILD_PARALLELISM: 2

    steps:
    - name: Check out repo
      uses: actions/checkout@v4.1.5

    # - name: Pull ccache cache
    #   id: ccache-restore
    #   uses: actions/cache/restore@v4
    #   with:
    #     path: /home/runner/.cache/ccache
    #     key: ccache-documentation-ci

    # - uses: actions/setup-python@v5
    #   with:
    #     python-version: '3.11'

    # - name: Install Ubuntu packages
    #   run: |
    #     sudo apt-get update
    #     sudo apt-get install mpi-default-bin mpi-default-dev libmetis-dev libparmetis-dev libsuitesparse-dev ccache

    # - name: Install Python dependencies
    #   run: make prereq && make prereq-extra

    # - name: Install
    #   run: make dev

    # - name: Remove ccache cache
    #   if: ${{ steps.ccache-restore.outputs.cache-hit }}
    #   shell: bash
    #   env:
    #     GH_TOKEN: ${{ github.token }}
    #   run: |
    #     gh extension install actions/gh-actions-cache
    #     gh actions-cache delete ccache --confirm
    #   continue-on-error: true

    # - name: Push ccache cache
    #   uses: actions/cache/save@v4
    #   with:
    #     path: /home/runner/.cache/ccache
    #     key: ccache-documentation-ci

    # - name: Build documentation
    #   run: |
    #     make docs

    # - name: Upload artifact
    #   uses: actions/upload-artifact@v4
    #   with:
    #     path: 'docs/build'