未验证 提交 05b8ba81 编写于 作者: H Hui Zhang 提交者: GitHub

Merge pull request #1637 from KPatr1ck/docs

[Audio][docs]Update README.md
# PaddleAudio
PaddleAudio is an audio library for PaddlePaddle.
## Install
`pip install .`
# 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.
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册