diff --git a/paddleaudio/README.md b/paddleaudio/README.md new file mode 100644 index 00000000..697c0173 --- /dev/null +++ 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 index 8e4fccc5..20626f52 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. `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.