Add doc for kokoro 1.0

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

Hide file tree

Showing 5 changed files with 1,172 additions and 4 deletions.
diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml
@@ -59,7 +59,7 @@ jobs:
       - 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
@@ -192,6 +192,16 @@ jobs:
               cd ..
               rm -rf huggingface
 
+              git clone https://www.modelscope.cn/csukuangfj/sherpa-doc-files.git ms
+              cd ms
+              git lfs pull --include "*.wav"
+              ls -lh source/_static/*/
+              cd ..
+
+              mkdir -pv build/html/_static
+              cp -av ms/source/_static/* build/html/_static/
+              rm -rf ms
+
               pushd source/ncnn/tutorials
               sed -i.bak /cn\.rst/d ./index.rst
               popd
@@ -231,6 +241,7 @@ jobs:
 
               make latex
               mkdir -pv build/html/_static
+              rm -v build/html/_static/*/.gitignore
               cd build/latex
               #latexmk -interaction=nonstopmode -f -pdf -dvi- -ps- sherpa.tex || true
               latexmk -interaction=nonstopmode -f -pdf -dvi- -ps- sherpa.tex >/dev/null 2>&1 || true
@@ -250,12 +261,18 @@ jobs:
           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/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!