-
Notifications
You must be signed in to change notification settings - Fork 9
111 lines (95 loc) · 3.92 KB
/
build_doc.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
name: Build and Deploy latest Documentation
on:
push:
branches:
- master
tags:
- "v*.*.*"
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
defaults:
run:
shell: bash -el {0}
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
fetch-depth: 0 # Fetch full history and all tags
- name: Set up Miniconda
uses: conda-incubator/setup-miniconda@v3
with:
miniforge-version: latest
python-version: 3.12 # Specify the Python version compatible with your environment
environment-file: docs/environment.yml # Use your environment.yml to install dependencies
activate-environment: readthedocs # Name from environment.yml
auto-activate-base: false
- name: Determine build type
id: context
run: |
if [ "${{ github.event_name }}" == "pull_request" ]; then
echo "build_context=pr" >> $GITHUB_ENV
elif [[ "${{ github.ref }}" == refs/tags/* ]]; then
echo "build_context=tag" >> $GITHUB_ENV
else
echo "build_context=master" >> $GITHUB_ENV
fi
- name: Build PR preview docs
if: env.build_context == 'pr'
run: sphinx-build -E docs/source _build/html/pr-${{ github.event.pull_request.number }}
- name: Build master docs
if: env.build_context == 'master'
run: sphinx-multiversion docs/source _build/html -D "smv_tag_whitelist=None" -D "smv_branch_whitelist=master"
- name: Build tagged version docs
if: env.build_context == 'tag'
run: |
tag=${{ github.ref_name }}
sphinx-multiversion docs/source _build/html -D "smv_tag_whitelist=$tag" -D "smv_branch_whitelist=None"
- name: Create index.html redirect
if: env.build_context != 'pr'
run: |
git fetch origin gh-pages
git checkout gh-pages
# Collect version folders from gh-pages
gh_pages_tags=$(git ls-tree --name-only origin/gh-pages | grep '^v' || true)
# Collect version folders from current _build/html
local_tags=$(ls _build/html | grep '^v' || true)
# Combine both lists, sort them, and find the latest version
all_tags=$(echo -e "$gh_pages_tags\n$local_tags" | sort -V | uniq)
if [ -n "$all_tags" ]; then
latest_tag=$(echo "$all_tags" | tail -n 1)
redirect_target="$latest_tag/index.html"
else
redirect_target="master/index.html"
fi
# Ensure _build/html directory exists
mkdir -p _build/html
# Create index.html for redirect
echo '<!DOCTYPE html>' > _build/html/index.html
echo '<html>' >> _build/html/index.html
echo '<head>' >> _build/html/index.html
echo ' <meta http-equiv="refresh" content="0; url='$redirect_target'">' >> _build/html/index.html
echo ' <title>Redirecting...</title>' >> _build/html/index.html
echo '</head>' >> _build/html/index.html
echo '<body>' >> _build/html/index.html
echo ' <p>If you are not redirected automatically, follow this <a href="'$redirect_target'">link</a>.</p>' >> _build/html/index.html
echo '</body>' >> _build/html/index.html
echo '</html>' >> _build/html/index.html
- name: Deploy to GitHub Pages
if: env.build_context != 'pr'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/html
keep_files: true
- name: Deploy PR preview
if: env.build_context == 'pr'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/html
publish_branch: gh-pages-preview
destination_dir: pr-${{ github.event.pull_request.number }}