pages.yml

# Simple workflow for deploying static content to GitHub Pages
name: Deploy Pages
on:
  # Runs on pushes targeting the default branch
  push:
    branches: [ main ]
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false
jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Python environment
        uses: actions/setup-python@v5
        with:
          python-version: 3.11

      # - name: generat build folder
      #   run: |
      #     python -m pip install --upgrade pip
      #     pip install sphinx nbsphinx sphinx_rtd_theme sphinx-autodoc-typehints sphinx_copybutton pandoc
      #     cd docs
      #     make clean && make html

      # - name: Get conda - 3.9
      #   id: get-conda
      #   uses: conda-incubator/setup-miniconda@v3
      #   with:
      #     python-version: 3.9
      #     miniforge-variant: Mambaforge
      #     miniforge-version: latest
      #     activate-environment: test
      #     use-mamba: true

      - name: Dependencies
        id: install-dependencies
        run: |
          sudo apt install python3-sphinx pandoc
          python -m pip install --upgrade pip
          pip install sphinx nbsphinx sphinx_rtd_theme sphinx-autodoc-typehints sphinx_copybutton sphinx-tabs sphinxemoji pyyaml

      - name: Build
        run: |
          cd docs
          python build_doc.py

      - name: Setup Pages
        uses: actions/configure-pages@v4
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          # Upload entire repository
          path: './pages'
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4