You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
PaddleSpeech/paddleaudio/docs
KP 585eb9aec5
Update readme. test=doc
3 years ago
..
images Build docs for PaddleAudio. 3 years ago
source fix compliance test bug, and format 3 years ago
Makefile Build docs for PaddleAudio. 3 years ago
README.md Update readme. test=doc 3 years ago
make.bat Build docs for PaddleAudio. 3 years ago

README.md

Build docs for PaddleAudio

Execute the following steps in current directory.

1. Install

pip install Sphinx sphinx_rtd_theme

2. Generate API docs

Generate API docs from doc string.

sphinx-apidoc -fMeT -o source ../paddleaudio ../paddleaudio/utils --templatedir source/_templates

3. Build

sphinx-build source _html

4. Preview

Open _html/index.html for page preview.