From 5f602de8b6bae6120443dfd787ac9b36f5565a4d Mon Sep 17 00:00:00 2001
From: 游雁 <zhifu.gzf@alibaba-inc.com>
Date: 星期五, 05 五月 2023 17:32:00 +0800
Subject: [PATCH] docs

---
 docs/model_zoo/huggingface_models.md |    0 
 docs/reference/papers.md             |    0 
 docs/reference/application.md        |    0 
 docs/README.md                       |    4 ++--
 docs/reference/build_task.md         |    0 
 docs/model_zoo/modelscope_models.md  |    0 
 docs/index.rst                       |   16 ++++++++--------
 docs/installation/docker.md          |    0 
 docs/installation/installation.md    |    0 
 docs/reference/FQA.md                |    0 
 10 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index 91de3c6..4e16b04 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -12,8 +12,8 @@
 Then you can generate HTML manually.
 
 ```sh
-cd FunASR/docs
+cd docs
 make html
 ```
 
-The generated files are all contained in the "FunASR/docs/_build" directory. You can access the FunASR documentation by simply opening the "html/index.html" file in your browser from this directory.~~
\ No newline at end of file
+The generated files are all contained in the "FunASR/docs/_build" directory. You can access the FunASR documentation by simply opening the "html/index.html" file in your browser from this directory.
\ No newline at end of file
diff --git a/docs/index.rst b/docs/index.rst
index 890768e..c2656bd 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -17,8 +17,8 @@
    :maxdepth: 1
    :caption: Installation
 
-   ./installation.md
-   ./docker.md
+   ./installation/installation.md
+   ./installation/docker.md
 
 .. toctree::
    :maxdepth: 1
@@ -57,8 +57,8 @@
    :maxdepth: 1
    :caption: Model Zoo
 
-   ./modelscope_models.md
-   ./huggingface_models.md
+   ./model_zoo/modelscope_models.md
+   ./model_zoo/huggingface_models.md
 
 .. toctree::
    :maxdepth: 1
@@ -86,25 +86,25 @@
    :maxdepth: 1
    :caption: Funasr Library
 
-   ./build_task.md
+   ./reference/build_task.md
 
 .. toctree::
    :maxdepth: 1
    :caption: Papers
 
-   ./papers.md
+   ./reference/papers.md
 
 .. toctree::
    :maxdepth: 1
    :caption: Application
 
-   ./application.md
+   ./reference/application.md
 
 .. toctree::
    :maxdepth: 1
    :caption: FQA
 
-   ./FQA.md
+   ./reference/FQA.md
 
 
 Indices and tables
diff --git a/docs/docker.md b/docs/installation/docker.md
similarity index 100%
rename from docs/docker.md
rename to docs/installation/docker.md
diff --git a/docs/installation.md b/docs/installation/installation.md
similarity index 100%
rename from docs/installation.md
rename to docs/installation/installation.md
diff --git a/docs/huggingface_models.md b/docs/model_zoo/huggingface_models.md
similarity index 100%
rename from docs/huggingface_models.md
rename to docs/model_zoo/huggingface_models.md
diff --git a/docs/modelscope_models.md b/docs/model_zoo/modelscope_models.md
similarity index 100%
rename from docs/modelscope_models.md
rename to docs/model_zoo/modelscope_models.md
diff --git a/docs/FQA.md b/docs/reference/FQA.md
similarity index 100%
rename from docs/FQA.md
rename to docs/reference/FQA.md
diff --git a/docs/application.md b/docs/reference/application.md
similarity index 100%
rename from docs/application.md
rename to docs/reference/application.md
diff --git a/docs/build_task.md b/docs/reference/build_task.md
similarity index 100%
rename from docs/build_task.md
rename to docs/reference/build_task.md
diff --git a/docs/papers.md b/docs/reference/papers.md
similarity index 100%
rename from docs/papers.md
rename to docs/reference/papers.md

--
Gitblit v1.9.1