Doc for flutter (#614)

k2-fsa · Jun 23, 2024 · 8b1ad0e · 8b1ad0e
1 parent f35a1f9
commit 8b1ad0e
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml
@@ -139,6 +139,15 @@ jobs:
               cd ..
               rm -rf huggingface
 
+              git clone https://huggingface.co/csukuangfj/sherpa-onnx-flutter huggingface
+              cd huggingface
+              ./generate-asr.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
+              cd ..
+              rm -rf huggingface
+
               pushd source/ncnn/tutorials
               sed -i.bak /cn\.rst/d ./index.rst
               popd

diff --git a/docs/source/onnx/flutter/index.rst b/docs/source/onnx/flutter/index.rst
@@ -0,0 +1,9 @@
+.. _sherpa-onnx-flutter:
+
+Flutter
+=======
+
+.. toctree::
+   :maxdepth: 2
+
+   ./pre-built-app.rst
diff --git a/docs/source/onnx/flutter/pre-built-app.rst b/docs/source/onnx/flutter/pre-built-app.rst
@@ -0,0 +1,17 @@
+Pre-built Flutter Apps
+======================
+
+Links for pre-built Apps can be found in the following table:
+
+.. hint::
+
+   It runs locally, without internet connection.
+
+.. list-table::
+
+ * - ****
+   - 中国用户
+   - URL
+ * - Streaming speech recognition
+   - `点这里 <https://k2-fsa.github.io/sherpa/onnx/flutter/asr/app-cn.html>`_
+   - `<https://k2-fsa.github.io/sherpa/onnx/flutter/asr/app.html>`_
diff --git a/docs/source/onnx/index.rst b/docs/source/onnx/index.rst
@@ -37,6 +37,7 @@ Also, we show how to use it for speech recognition with pre-trained models.
    ./wasm/index
    ./android/index
    ./ios/index
+   ./flutter/index
    ./websocket/index
    ./hotwords/index
    ./kws/index