Merge pull request #1637 from KPatr1ck/docs

[Audio][docs]Update README.md
r0.2 r0.2.0
Hui Zhang 2 years ago committed by GitHub
commit 05b8ba818b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,7 @@
# PaddleAudio
PaddleAudio is an audio library for PaddlePaddle.
## Install
`pip install .`

@ -1,14 +1,15 @@
# Build docs for PaddleAudio
Execute the following steps in **current directory**.
## 1. Install
`pip install Sphinx`
`pip install sphinx_rtd_theme`
`pip install Sphinx sphinx_rtd_theme`
## 2. Generate API docs
Exclude `paddleaudio.utils`
Generate API docs from doc string.
`sphinx-apidoc -fMeT -o source ../paddleaudio ../paddleaudio/utils --templatedir source/_templates`
@ -16,3 +17,8 @@ Exclude `paddleaudio.utils`
## 3. Build
`sphinx-build source _html`
## 4. Preview
Open `_html/index.html` for page preview.

Loading…
Cancel
Save