-
Notifications
You must be signed in to change notification settings - Fork 108
188 lines (161 loc) · 6.79 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
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
177
178
179
180
181
182
183
184
185
186
187
188
# Copyright 2022 Xiaomi Corp. (author: Fangjun Kuang)
# See ../../LICENSE for clarification regarding multiple authors
#
# 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.
# refer to https://github.com/actions/starter-workflows/pull/47/files
# You can access it at https://k2-fsa.github.io/sherpa/
name: Generate doc
on:
push:
branches:
- master
- doc
paths:
- '.github/workflows/build-doc.yml'
- 'docs/**'
# schedule:
# # minute (0-59)
# # hour (0-23)
# # day of the month (1-31)
# # month (1-12)
# # day of the week (0-6)
# # nightly build at 23:50 UTC time every day
# - cron: "50 23 * * *"
workflow_dispatch:
concurrency:
group: build-doc-${{ github.ref }}
cancel-in-progress: true
jobs:
build-doc:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]
python-version: [3.8]
steps:
# refer to https://github.com/actions/checkout
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run docker
uses: addnab/docker-run-action@v3
with:
image: reitzig/texlive-full:latest
# image: ghcr.io/xu-cheng/texlive-full:latest
options: |
--volume ${{ github.workspace }}/:/workspace
shell: bash
run: |
uname -a
cat /etc/*release
id
pwd
ls -lh
cd /workspace
which latexmk
apk add --no-cache python3 py3-pip git make gcc zlib-dev libffi-dev openssl-dev musl-dev ghostscript
python3 --version
python3 -m venv abc
source ./abc/bin/activate
python3 -m ensurepip
python3 -m pip install -r ./docs/requirements.txt
cd docs
make html
touch build/html/.nojekyll
export GIT_LFS_SKIP_SMUDGE=1
git clone https://huggingface.co/csukuangfj/sherpa-onnx-apk huggingface
cd huggingface
./generate-asr.py
./generate-asr-2pass.py
./generate-tts.py
./generate-tts-engine.py
./generate-speaker-identification.py
./generate-audio-tagging.py
./generate-audio-tagging-wearos.py
./generate-slid.py
./generate-kws.py
./generate-vad.py
./generate-vad-asr.py
mv -v apk-asr.html ../build/html/onnx/android/apk.html
mv -v apk-asr-2pass.html ../build/html/onnx/android/apk-2pass.html
mv -v apk.html ../build/html/onnx/tts/
mv -v apk-engine.html ../build/html/onnx/tts/
mv -v apk-speaker-identification.html ../build/html/onnx/speaker-identification/apk.html
mv -v apk-audio-tagging.html ../build/html/onnx/audio-tagging/apk.html
mv -v apk-audio-tagging-wearos.html ../build/html/onnx/audio-tagging/apk-wearos.html
mv -v apk-slid.html ../build/html/onnx/spoken-language-identification/apk.html
mv -v apk-kws.html ../build/html/onnx/kws/apk.html
mv -v apk-vad.html ../build/html/onnx/vad/apk.html
mv -v apk-vad-asr.html ../build/html/onnx/vad/apk-asr.html
mv -v apk-asr-cn.html ../build/html/onnx/android/apk-cn.html
mv -v apk-asr-2pass-cn.html ../build/html/onnx/android/apk-2pass-cn.html
mv -v apk-cn.html ../build/html/onnx/tts/
mv -v apk-engine-cn.html ../build/html/onnx/tts/
mv -v apk-speaker-identification-cn.html ../build/html/onnx/speaker-identification/apk-cn.html
mv -v apk-audio-tagging-cn.html ../build/html/onnx/audio-tagging/apk-cn.html
mv -v apk-audio-tagging-wearos-cn.html ../build/html/onnx/audio-tagging/apk-wearos-cn.html
mv -v apk-slid-cn.html ../build/html/onnx/spoken-language-identification/apk-cn.html
mv -v apk-kws-cn.html ../build/html/onnx/kws/apk-cn.html
mv -v apk-vad-cn.html ../build/html/onnx/vad/apk-cn.html
mv -v apk-vad-asr-cn.html ../build/html/onnx/vad/apk-asr-cn.html
cd ..
rm -rf huggingface
git clone https://huggingface.co/csukuangfj/sherpa huggingface
cd huggingface
./run.sh
cp cpu.html ../build/html
cp cuda.html ../build/html
cd ..
rm -rf huggingface
git clone https://huggingface.co/csukuangfj/sherpa-onnx-flutter huggingface
cd huggingface
./generate-asr.py
./generate-tts.py
mkdir -p ../build/html/onnx/flutter/asr
mv -v app-asr.html ../build/html/onnx/flutter/asr/app.html
mv -v app-asr-cn.html ../build/html/onnx/flutter/asr/app-cn.html
mv -v tts*.html ../build/html/onnx/flutter/
cd ..
rm -rf huggingface
pushd source/ncnn/tutorials
sed -i.bak /cn\.rst/d ./index.rst
popd
pushd source/onnx/tutorials
sed -i.bak /cn\.rst/d ./index.rst
popd
pushd source/onnx/pretrained_models/offline-transducer/
sed -i.bak /sherpa-onnx-zipformer-thai-2024-06-20\.txt/d zipformer-transducer-models.rst
sed -i.bak /sherpa-onnx-zipformer-thai-2024-06-20-int8\.txt/d zipformer-transducer-models.rst
popd
git diff
make latex
mkdir -pv build/html/_static
cd build/latex
latexmk -interaction=nonstopmode -f -pdf -dvi- -ps- sherpa.tex || true
ls -lh sherpa.pdf
cp -v sherpa.pdf ../html/
- name: Release sherpa.pdf
if: (github.repository_owner == 'csukuangfj' || github.repository_owner == 'k2-fsa') && github.event_name == 'push'
uses: svenstaro/upload-release-action@v2
with:
file_glob: true
overwrite: true
file: ./docs/build/html/sherpa.pdf
tag: doc
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
publish_branch: gh-pages