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.
25 lines
403 B
25 lines
403 B
3 years ago
|
# Build docs for PaddleAudio
|
||
|
|
|
||
|
3 years ago
|
Execute the following steps in **current directory**.
|
||
|
|
|
||
|
3 years ago
|
## 1. Install
|
||
|
|
|
||
|
3 years ago
|
`pip install Sphinx sphinx_rtd_theme`
|
||
|
3 years ago
|
|
||
|
|
|
||
|
|
## 2. Generate API docs
|
||
|
|
|
||
|
3 years ago
|
Generate API docs from doc string.
|
||
|
3 years ago
|
|
||
|
|
`sphinx-apidoc -fMeT -o source ../paddleaudio ../paddleaudio/utils --templatedir source/_templates`
|
||
|
|
|
||
|
|
|
||
|
|
## 3. Build
|
||
|
|
|
||
3 years ago
|
`sphinx-build source _html`
|
||
|
3 years ago
|
|
||
|
|
|
||
|
|
## 4. Preview
|
||
|
|
|
||
|
|
Open `_html/index.html` for page preview.
|