From 2a8b44c525030b3c5d98611c4dd65ec4a95ea4d1 Mon Sep 17 00:00:00 2001
From: KP <109694228@qq.com>
Date: Fri, 1 Apr 2022 14:37:23 +0800
Subject: [PATCH] Update README.md

Update readme in docs. test=doc
---
 paddleaudio/docs/README.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/paddleaudio/docs/README.md b/paddleaudio/docs/README.md
index 8e4fccc5b..f35d1d00e 100644
--- a/paddleaudio/docs/README.md
+++ b/paddleaudio/docs/README.md
@@ -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 `*py`
 
 `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.