doc.yml

name: darts documentation build and release workflow

on:
  workflow_dispatch:

jobs:
  deploy-docs:
    runs-on: ubuntu-latest
    steps:
      - name: "Clone repository"
        uses: actions/checkout@v4

      - name: "Set up Python 3.10"
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'

      # use `uv` to retrieve the latest dependency versions
      - name: "Compile Dependency Versions"
        run: |
          curl -LsSf https://astral.sh/uv/install.sh | sh
          uv pip compile requirements/dev-all.txt > requirements-latest.txt

      # only restore cache but do not upload
      - name: "Restore cached python environment"
        uses: actions/cache/restore@v4
        id: pythonenv-cache
        with:
          path: ${{ env.pythonLocation }}
          key: ${{ runner.os }}-${{ env.pythonLocation }}-${{ hashFiles('requirements/*.txt', 'requirements-latest.txt') }}

      - name: "Install pandoc"
        run: |
          sudo apt-get install -y pandoc

      - name: "Setup Pip"
        run: |
          python -m pip install --upgrade pip

      - name: "Install Dependencies"
        run: |
          # install latest dependencies (potentially updating cached dependencies)
          pip install -U -r requirements/dev-all.txt

      - name: "Install libomp (for LightGBM)"
        run: |
          ./.github/scripts/libomp-${{ runner.os }}.sh

      - name: "Install Locally"
        run: |
          pip install .

      - name: "Build docs"
        run: |
          make --directory ./docs build-all-docs

      - name: "Publish documentation to gh-pages"
        uses: s0/git-publish-subdir-action@v2.2.0
        env:
          REPO: self
          BRANCH: gh-pages
          FOLDER: docs/build/html
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}