Merge pull request #1637 from KPatr1ck/docs

[Audio][docs]Update README.md
PaddlePaddle · Apr 1, 2022 · 05b8ba8 · 05b8ba8
2 parents 5bff096 + 585eb9a
commit 05b8ba8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/paddleaudio/README.md b/paddleaudio/README.md
@@ -0,0 +1,7 @@
+# PaddleAudio
+
+PaddleAudio is an audio library for PaddlePaddle.
+
+## Install
+
+`pip install .`
diff --git a/paddleaudio/docs/README.md b/paddleaudio/docs/README.md
@@ -1,18 +1,24 @@
 # 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`
 
 
 ## 3. Build
 
 `sphinx-build source _html`
+
+
+## 4. Preview
+
+Open `_html/index.html` for page preview.