volara/.github/workflows/docs.yaml at main · e11bio/volara · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
name: Deploy Docs to GitHub Pages

on:
  push:
    branches: [main]
    tags: "*"
  workflow_dispatch:

# Allow this job to clone the repo and create a page deployment
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    defaults:
      run:
        shell: bash -l {0}
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Set up uv
        # Install a specific uv version using the installer
        run: curl -LsSf https://astral.sh/uv/0.4.1/install.sh | sh

      - name: Install pandoc
        uses: pandoc/actions/setup@v1

      - name: Build documentation
        run: |
          uv run --extra docs python -m ipykernel install --name volara_env --user
          uv run --extra docs jupytext --to notebook examples/getting_started/basics.py
          uv run --extra docs jupytext --to notebook examples/cremi/cremi.py
          cp -r examples docs/source
          uv run --extra docs sphinx-build docs/source docs/build/html -b html

      - name: Upload Pages Artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/build/html
          retention-days: 90

  deploy:
    # if: github.ref == 'refs/heads/main'
    needs: build
    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4