trajan/.github/workflows/sphinx-rtd.yml at 01e49e8bc230ca34beb6838230231d47650f3049 · OpenDrift/trajan · 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
name: Docs

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]
  pull_request:

  # 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 one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

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

      - uses: mamba-org/setup-micromamba@v2
        with:
          environment-file: environment.yml
          cache-environment: true
          post-cleanup: 'all'
          init-shell: >-
            bash
            powershell
          create-args: python=3.14

      - name: Install documentation dependencies
        run: |
          micromamba install -f docs/requirements.txt

      - name: Cache cartopy maps
        id: cache-cartopy
        uses: actions/cache@v4
        with:
          path: ~/.local/share/cartopy
          key: cartopy-maps-gshhg-2.3.7

      - name: Download cartopy shapefiles
        if: steps.cache-cartopy.outputs.cache-hit != 'true'
        run: |
          mkdir -p ~/.local/share/cartopy/shapefiles/
          cd ~/.local/share/cartopy/shapefiles/
          curl -L -o gshhg-shp-2.3.7.zip https://github.com/GenericMappingTools/gshhg-gmt/releases/download/2.3.7/gshhg-shp-2.3.7.zip
          unzip -o gshhg-shp-2.3.7.zip
          mv GSHHS_shp gshhs
          rm gshhg-shp-2.3.7.zip
          python -c "import cartopy; list(map(cartopy.io.shapereader.gshhs, ('c', 'l', 'i', 'h', 'f')))"
          python -c "import cartopy; cartopy.io.shapereader.natural_earth(resolution='110m', category='cultural', name='admin_0_countries')"

      - name: Build docs with sphinx
        run: |
          cd docs
          make html

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        id: deployment
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/build/html

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4