FunASR/docs
IrvingGao d7a6de771c first commit for takway.ai 2024-05-18 15:50:56 +08:00
..
images first commit for takway.ai 2024-05-18 15:50:56 +08:00
installation first commit for takway.ai 2024-05-18 15:50:56 +08:00
m2met2 first commit for takway.ai 2024-05-18 15:50:56 +08:00
reference first commit for takway.ai 2024-05-18 15:50:56 +08:00
tutorial first commit for takway.ai 2024-05-18 15:50:56 +08:00
Makefile first commit for takway.ai 2024-05-18 15:50:56 +08:00
README.md first commit for takway.ai 2024-05-18 15:50:56 +08:00
conf.py first commit for takway.ai 2024-05-18 15:50:56 +08:00
index.rst first commit for takway.ai 2024-05-18 15:50:56 +08:00
make.bat first commit for takway.ai 2024-05-18 15:50:56 +08:00

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:

pip3 install -U "funasr[docs]"

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.