generate_documentations.yml

name: Generate Documentations

on:
  push:
    tags:
      - "*"
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-24.04
    strategy:
      matrix:
        python-version: ["3.12"]
        c_compiler: [gcc-14]
        cxx_compiler: [g++-14]

    steps:
      - uses: actions/checkout@v4
        with:
          ssh-key: ${{secrets.RADARSIMC}}
          submodules: true
      - name: Set up Python ${{matrix.python-version}}
        uses: actions/setup-python@v5
        with:
          python-version: ${{matrix.python-version}}
      - name: Install dependencies
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt
          pip install Sphinx sphinx-rtd-theme
      - name: Build
        env:
          CC: ${{matrix.c_compiler}}
          CXX: ${{matrix.cxx_compiler}}
        run: |
          sudo chown -R $USER:$USER /home/runner/work/radarsimpy
          chmod +x build_linux.sh
          ./build_linux.sh --tier=standard --arch=cpu --test=off
      - name: Generate documentation
        run: |
          cd gen_docs && make html && cd ..
      - name: Archive documentation
        if: success()
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: ./gen_docs/_build/html
      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: "./gen_docs/_build/html"
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4