-
Notifications
You must be signed in to change notification settings - Fork 16
112 lines (103 loc) · 3.17 KB
/
check-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
name: Building docs
on:
workflow_call:
inputs:
python-version:
description: "Python version to use"
default: "3.9"
required: false
type: string
docs-dir:
description: "Working directory to run make docs in"
default: "./docs"
required: false
type: string
timeout-minutes:
description: "timeout-minutes for each job"
default: 15
required: false
type: number
requirements-file:
description: "path to the requirement file"
default: "requirements/docs.txt"
required: false
type: string
env-vars:
description: "custom environment variables in json format"
required: false
type: string
default: |
{
"SPHINX_MOCK_REQUIREMENTS": 0,
}
make-target:
description: "what test configs to run in json format"
required: false
type: string
default: |
["html", "doctest", "linkcheck"]
install-tex:
description: "optional installing Texlive support - true|false"
required: false
type: string
default: false
defaults:
run:
shell: bash
env:
# just use CPU version since running on CPU machine
TORCH_URL: "https://download.pytorch.org/whl/cpu/torch_stable.html"
# default 0 means to keep for the maximum time
KEEP_DAYS: 0
jobs:
make-docs:
runs-on: ubuntu-22.04
env: ${{ fromJSON(inputs.env-vars) }}
strategy:
fail-fast: false
matrix:
target: ${{ fromJSON(inputs.make-target) }}
steps:
- name: Checkout 🛎
uses: actions/checkout@v4
with:
submodules: recursive
- name: Set up Python 🐍 ${{ inputs.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ inputs.python-version }}
- name: Install pandoc & texlive
if: ${{ inputs.install-tex == 'true' }}
timeout-minutes: 10
run: |
sudo apt-get update --fix-missing
sudo apt-get install -y \
pandoc \
texlive-latex-extra \
dvipng \
texlive-pictures \
latexmk
# todo: consider adding cache with separate restore/save
- name: Install dependencies
timeout-minutes: 20
run: |
pip --version
pip install -e . -U -r ${{ inputs.requirements-file }} -f ${TORCH_URL}
pip list
# TODO: re-enable after the external usage is resolved, see #51
# - uses: ./.github/actions/pip-list
- name: Build documentation
working-directory: ${{ inputs.docs-dir }}
run: |
make ${{ matrix.target }} \
--debug --jobs $(nproc) SPHINXOPTS="-W --keep-going"
- name: Shorten keep artifact
if: startsWith(github.event_name, 'pull_request')
run: echo "KEEP_DAYS=7" >> $GITHUB_ENV
- name: Upload built docs
uses: actions/upload-artifact@v3
with:
name: docs-${{ matrix.target }}-${{ github.sha }}
path: ${{ inputs.docs-dir }}/build/
retention-days: ${{ env.KEEP_DAYS }}
include-hidden-files: true