[doc] reorg document (wenet-e2e#1732)

Mddct · Mar 10, 2023 · 46eb1d4 · 46eb1d4
1 parent 1cfe930
commit 46eb1d4
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 21 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,14 +10,14 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Wenet'
+project = 'wenet'
 copyright = '2020, wenet-team'
 author = 'wenet-team'
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,29 +1,22 @@
-.. Wenet documentation master file, created by
+.. wenet documentation master file, created by
    sphinx-quickstart on Thu Dec  3 11:43:53 2020.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Wenet's documentation!
+Welcome to wenet's documentation!
 =================================
 
 
-Wenet is an tansformer-based end-to-end ASR toolkit.
+wenet is an tansformer-based end-to-end ASR toolkit.
 
 .. toctree::
-   :maxdepth: 1
-   :caption: Tutorial:
-
-   ./python_binding.md
-   ./papers.md
-   ./tutorial_librispeech.md
-   ./tutorial_aishell.md
-   ./pretrained_models.md
-   ./lm.md
-   ./context.md
-   ./runtime.md
-   ./jit_in_wenet.md
-   ./UIO.md
+   :maxdepth: 2
+   :caption: Contents:
 
+   ./install.md
+   ./train.rst
+   ./production.rst
+   ./reference.rst
 
 Indices and tables
 ==================

diff --git a/docs/production.rst b/docs/production.rst
@@ -0,0 +1,11 @@
+Production Runtime
+==================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   ./lm.md
+   ./context.md
+   ./runtime.md
+   ./jit_in_wenet.md
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -0,0 +1,10 @@
+Reference
+=========
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   ./python_binding.md
+   ./papers.md
+
diff --git a/docs/train.rst b/docs/train.rst
@@ -0,0 +1,11 @@
+How to train models?
+====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   ./tutorial_librispeech.md
+   ./tutorial_aishell.md
+   ./pretrained_models.md
+   ./UIO.md
diff --git a/runtime/binding/python/README.md b/runtime/binding/python/README.md
@@ -1,4 +1,4 @@
-# WeNet Python Binding
+# Python Binding
 
 This is a python binding of WeNet.