-
Notifications
You must be signed in to change notification settings - Fork 87
176 lines (152 loc) · 5.7 KB
/
build-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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
###############################################################################
#
# Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by
# Analog Devices, Inc.),
# Copyright (C) 2023-2024 Analog Devices, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
##############################################################################
name: Build & Deploy Docs
# Controls when the workflow will run
on:
push:
branches: [ "release" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v2.3.3
with:
cache: pip
- name: Install mkdocs
run: pip install -r Documentation/requirements.txt
- name: Doxygen (MAX32520)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32520_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32570)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32570_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32572)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32572_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32650)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32650_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32655)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32655_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32660)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32660_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32662)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32662_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32665)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32665_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32670)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32670_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32672)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32672_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32675)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32675_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32680)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32680_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX32690)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max32690_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX78000)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max78000_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Doxygen (MAX78002)
uses: mattnotmitt/doxygen-action@1.9.4
with:
# Path to Doxyfile
doxyfile-path: max78002_Doxyfile
# Working directory
working-directory: Libraries/PeriphDrivers/Documentation
- name: Build User Guide
run: | # Build Documentation Folder and run mkdocs
python3 Documentation/build.py
- name: Publish
uses: JamesIves/github-pages-deploy-action@v4.3.0
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs # Deploy the built docs folder