Add doc for kokoro 1.0 (#713)

k2-fsa · Feb 14, 2025 · 7df3e46 · 7df3e46
1 parent d3c953b
commit 7df3e46
Show file tree

Hide file tree

Showing 6 changed files with 1,174 additions and 5 deletions.
diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml
@@ -56,10 +56,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Copy wave files
+        shell: bash
+        run: |
+          cd docs/source
+
+          git lfs install
+          git clone https://www.modelscope.cn/csukuangfj/sherpa-doc-files.git ms
+          ls -lh _static/*
+          cp -av ms/source/_static/* ./_static/
+          rm -rf ms
+
       - name: Run docker
         uses: addnab/docker-run-action@v3
         with:
-            image: reitzig/texlive-base:latest
+            image: reitzig/texlive-full:latest
             # image: ghcr.io/xu-cheng/texlive-full:latest
             options: |
               --volume ${{ github.workspace }}/:/workspace
@@ -245,17 +256,24 @@ jobs:
         shell: bash
         run: |
           cd docs/build/html
+
           ls -lh
 
           echo "-----_static-----"
           ls -lh _static
 
+          ls -lha _static/kokoro-multi-*/
+
+          rm -fv _static/kokoro-multi-*/.gitignore
+
+          echo "---"
+          ls -lha _static/kokoro-multi-*/
+
           echo "-----_static/sense-voice-----"
           ls -lh _static/sense-voice
 
       - name: Release sherpa.pdf
-        # if: (github.repository_owner == 'csukuangfj' || github.repository_owner == 'k2-fsa') && github.event_name == 'push'
-        if: false
+        if: (github.repository_owner == 'csukuangfj' || github.repository_owner == 'k2-fsa') && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
         uses: svenstaro/upload-release-action@v2
         with:
           file_glob: true

diff --git a/docs/source/_static/kokoro-multi-lang-v1_0/.gitignore b/docs/source/_static/kokoro-multi-lang-v1_0/.gitignore
@@ -0,0 +1 @@
+*.wav
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -127,7 +127,7 @@ def get_version():
 .. _WeNet: https://github.com/wenet-e2e/wenet
 .. _GigaSpeech: https://github.com/SpeechColab/GigaSpeech
 .. _Kaldi: https://github.com/kaldi-asr/kaldi
-.. _kaldifeat: https://csukuangfj.github.io/kaldifeat/installation.html
+.. _kaldifeat: https://csukuangfj.github.io/kaldifeat/installation/index.html
 .. _ncnn: https://github.com/tencent/ncnn
 .. _sherpa-ncnn: https://github.com/k2-fsa/sherpa-ncnn
 .. _onnx: https://github.com/onnx/onnx

diff --git a/docs/source/onnx/install/windows.rst b/docs/source/onnx/install/windows.rst
@@ -65,9 +65,15 @@ All you need is to run:
 
       .. hint::
 
-          You need to install CUDA toolkit. Otherwise, you would get
+          You need to install CUDA toolkit 11.8. Otherwise, you would get
           errors at runtime.
 
+          Caution: Please install cuda toolkit 11.8. Other versions do ``NOT`` work!
+
+          Caution: Please install cuda toolkit 11.8. Other versions do ``NOT`` work!
+
+          Caution: Please install cuda toolkit 11.8. Other versions do ``NOT`` work!
+
 After building, you will find an executable ``sherpa-onnx.exe`` inside the ``bin/Release`` directory.
 
 That's it!