-
-
Notifications
You must be signed in to change notification settings - Fork 260
128 lines (106 loc) · 3.51 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
name: Build Documentation
on:
workflow_call:
inputs:
publish:
required: true
type: boolean
workflow_dispatch:
inputs:
publish:
required: true
type: boolean
pin-tag:
# pin-tag can be used to keep the latest X.Y.Z release tag instead of
# a X.Y.Z-devN tag when updating the docs after a release
required: false
type: string
release:
types: [ released ]
env:
# Set environment variable with value from configuration variable
FASTF1_DOCS_ERGAST_BACKEND_OVERRIDE: ${{ vars.FASTF1_DOCS_ERGAST_BACKEND_OVERRIDE }}
jobs:
build_docs:
if: (!contains(github.event.head_commit.message, '[skip-doc-build]')) || inputs.publish
name: Build Documentation
runs-on: ubuntu-latest
steps:
- name: Setup python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Checkout repo
uses: actions/checkout@v4
with:
fetch-depth: 0 # fetch the complete repo history (for setuptools-scm)
- name: Cache pip
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: pip-cache-${{ hashFiles('requirements/*.txt') }}
restore-keys: |
pip-cache
- name: Install python requirements
run: |
python -m pip install --upgrade pip
python -m pip install --upgrade build twine
python -m pip install -r requirements/dev.txt
- name: Create cache directory
run: |
mkdir doc_cache # make sure cache dir exists
- name: Cache FastF1
uses: actions/cache@v4
with:
save-always: true
path: ./doc_cache
key: fastf1-doc-cache-${{ hashFiles('*.*') }}
restore-keys: |
fastf1-doc-cache
- name: Install at pinned tag
if: inputs.pin-tag != ''
run: |
git checkout ${{ inputs.pin-tag }}
- name: Install Fast-F1 from sources
run: |
python -m pip install -e .
- name: Re-checkout current commit after install at pinned tag
if: inputs.pin-tag != ''
run: |
git checkout ${{ github.sha }}
- name: Create doc build dir
run: |
mkdir -p docs/_build/html
- name: Checkout current docs
uses: actions/checkout@v4
with:
ref: gh-pages
path: docs/_build/html
- name: Build docs
run: |
mkdir test_cache # not really need but pytest setup relies on it
# delete all files in build directory, will be replaced with new
# build (don't use "make clean" as it deletes the .git folder)
# need to go to nested git repository in build directory
cd ./docs/_build/html
git rm -r *
# go back to docs folder in main repository
cd ../..
make html
- name: Prepare docs for publishing
run: |
cd docs/_build/html
git add .
git config user.name github-actions
git config user.email [email protected]
git commit -m "$GITHUB_REF_NAME ($GITHUB_JOB) ci release"
- name: Publish docs
if: (github.event_name == 'release') || inputs.publish
run: |
git push origin gh-pages --force
- name: Upload docs as artifact
uses: actions/upload-artifact@v4
if: github.event_name != 'release'
with:
name: Documentation Build
path: docs/_build/html