-
Notifications
You must be signed in to change notification settings - Fork 75
93 lines (81 loc) · 2.53 KB
/
docs.yml
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
93
name: Build Docs
# We don't want pushes (or PRs) to gh-pages to kick anything off
on:
push:
branches:
- main
- '[0-9]+.[0-9]+.x'
tags:
- v[0-9]+.[0-9]+.[0-9]+
pull_request:
permissions:
contents: write
concurrency:
group: ${{ github.workflow}}-${{ github.head_ref }}
cancel-in-progress: true
jobs:
#
# Build our docs on Linux against multiple Pythons
#
Docs:
name: "Linux ${{ matrix.python-version }}"
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ['3.10', 3.11, 3.12]
check-links: [false]
include:
- python-version: 3.13
check-links: true
outputs:
doc-version: ${{ steps.build-docs.outputs.doc-version }}
steps:
- name: Checkout source
uses: actions/checkout@v4
with:
fetch-depth: 150
- name: Get tags
run: git fetch --depth=1 origin +refs/tags/*:refs/tags/*
- name: Install using PyPI
uses: Unidata/MetPy/.github/actions/install-pypi@main
with:
type: 'doc'
python-version: ${{ matrix.python-version }}
need-extras: true
need-cartopy: true
- name: Build docs
id: build-docs
uses: Unidata/MetPy/.github/actions/build-docs@main
with:
run-linkchecker: ${{ github.event_name == 'pull_request' && matrix.check-links == true }}
key: ${{ runner.os }}-${{ matrix.python-version }}
make-targets: ''
Deploy:
if: ${{ github.event_name != 'pull_request' }}
needs: Docs
environment:
name: github-pages
runs-on: ubuntu-latest
env:
DOC_VERSION: dev
steps:
- name: Download doc build
uses: actions/download-artifact@v4
with:
name: Linux-3.11-docs
path: ./docs/build/html
# This overrides the version "dev" with the proper version if we're building off a
# branch that's not main (which is confined to n.nn.x above) or on a tag.
- name: Set doc version
if: ${{ github.event_name != 'push' || !contains(github.ref, 'main') }}
run: echo "DOC_VERSION=v${{ needs.Docs.outputs.doc-version }}" >> $GITHUB_ENV
- name: Upload to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
deploy_key: ${{ secrets.GHPAGES_DEPLOY_KEY }}
publish_dir: ./docs/build/html
exclude_assets: '.buildinfo,_static/jquery-*.js,_static/underscore-*.js'
destination_dir: ./${{ env.DOC_VERSION }}
keep_files: false
full_commit_message: Deploy ${{ env.DOC_VERSION }} to GitHub Pages