Build Doc for PaddleSpeech API

Jump to bottom

Hui Zhang edited this page Jul 11, 2022 · 2 revisions

Build docs for PaddleSpeech Execute the following steps in current directory.

Install

pip install Sphinx sphinx_rtd_theme

Generate API docs Generate API docs from doc string.

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

sphinx-apidoc -o ./docs/source/api ./paddlespeech -f -e -M

Build

sphinx-build source _html

Preview Open _html/index.html for page preview.

Reference

https://github.com/PaddlePaddle/PaddleSpeech/blob/r1.0/audio/docs/README.md