docs_deployment.yaml

name: Docs

on:
  push:
    branches: ["main"]

permissions:
  contents: read
  pages: write
  id-token: write

  #env:
  #  SETUPTOOLS_ENABLE_FEATURES: legacy-editable

jobs:
  docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Get token from Github App
        uses: actions/create-github-app-token@v1
        id: app_token
        with:
          app-id: ${{ secrets.APP_ID }}
          private-key: ${{ secrets.APP_PEM }}
          # owner is required, otherwise the creds will fail the checkout step
          owner: ${{ github.repository_owner }}

      - name: Checkout from GitHub
        uses: actions/checkout@v4
        with:
          lfs: 'false'
          submodules: true
          ssh-key: ${{ secrets.git_ssh_key  }}
          token: ${{ steps.app_token.outputs.token }}
      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version: 3.11
          architecture: x64
          cache: 'pip'

      - name: Install libboost
        run: sudo apt install libboost-dev
      - name: Install Python dependencies
        run: pip install -e '.[modules, docs]'
      - name: Build Docs
        run: cd ./docs; make html
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: './docs/build/html'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2.0.4