docs.yml

name: Docs

on:
  push:
    tags:
     - '*'

env:
  GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

jobs:
  notebooks:
    name: "Build the notebooks for the docs"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4.1.6

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

      - name: Install dependencies
        run: |
          python -m pip install -U pip
          python -m pip install -r .github/workflows/requirements_docs.txt

      # - name: Execute the notebooks
      #   run: |
      #     jupytext --to ipynb --execute docs/source/getting_started/*.ipynb

      - uses: actions/upload-artifact@v4.3.3
        with:
          name: notebooks-for-${{ github.sha }}
          path: docs/source/getting_started

      - name: Trigger RTDs build
        uses: dfm/rtds-action@v1
        with:
          webhook_url: ${{ secrets.RTDS_WEBHOOK_URL }}
          webhook_token: ${{ secrets.RTDS_WEBHOOK_TOKEN }}
          commit_ref: ${{ github.ref }}