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