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.
18 lines
295 B
18 lines
295 B
3 years ago
|
# Build docs for PaddleAudio
|
||
|
|
|
||
|
|
## 1. Install
|
||
|
|
|
||
|
|
`pip install Sphinx`
|
||
|
|
`pip install sphinx_rtd_theme`
|
||
|
|
|
||
|
|
|
||
|
|
## 2. Generate API docs
|
||
|
|
|
||
|
|
Exclude `paddleaudio.utils`
|
||
|
|
|
||
|
|
`sphinx-apidoc -fMeT -o source ../paddleaudio ../paddleaudio/utils --templatedir source/_templates`
|
||
|
|
|
||
|
|
|
||
|
|
## 3. Build
|
||
|
|
|
||
|
|
`sphinx-build source _html`
|