From 5f7f2ae41dac5264d33c88e6c0a7286b9542fa2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=98=89=E6=B8=8A?= Date: Fri, 5 May 2023 16:44:53 +0800 Subject: [PATCH] update repo --- docs/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..91de3c6ff --- /dev/null +++ b/docs/README.md @@ -0,0 +1,19 @@ +# 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: +```sh +conda activate funasr +pip install requests sphinx nbsphinx sphinx_markdown_tables sphinx_rtd_theme recommonmark +``` + +Then you can generate HTML manually. + +```sh +cd FunASR/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.~~ \ No newline at end of file