zhifu gao 7e63de52f0 Merge pull request #519 from alibaba-damo-academy/main 2 lat temu
..
academic_recipe 2a475a112f docs 2 lat temu
benchmark 8b2e4644bd onnx cpp benchmark 2 lat temu
images acf97731ec readme 2 lat temu
installation 5f602de8b6 docs 2 lat temu
m2met2 35940da115 update url 2 lat temu
m2met2_cn 35940da115 update url 2 lat temu
model_zoo 698ba630a0 docs 2 lat temu
modelscope_pipeline 1fadb21eb6 docs 2 lat temu
reference 8629d30d3d update repo 2 lat temu
runtime a3c0a0c4bf websocket docs 2 lat temu
Makefile 8b3e0e52c5 update github.io page 3 lat temu
README.md 5f602de8b6 docs 2 lat temu
conf.py 9ec68fe1bc add github.io page 3 lat temu
index.rst 5f602de8b6 docs 2 lat temu
make.bat 9ec68fe1bc add github.io page 3 lat temu

README.md

FunASR document generation

Generate HTML

For convenience, we provide users with the ability to generate local HTML manually.

First, you should install the following packages, which is required for building HTML:

conda activate funasr
pip install requests sphinx nbsphinx sphinx_markdown_tables sphinx_rtd_theme recommonmark

Then you can generate HTML manually.

cd docs
make html

The generated files are all contained in the "FunASR/docs/_build" directory. You can access the FunASR documentation by simply opening the "html/index.html" file in your browser from this directory.