From 46eb1d40560f098e18bb190c83693d3d875d45d8 Mon Sep 17 00:00:00 2001 From: Binbin Zhang Date: Fri, 10 Mar 2023 16:35:10 +0800 Subject: [PATCH] [doc] reorg document (#1732) --- docs/conf.py | 8 ++++---- docs/index.rst | 25 +++++++++---------------- docs/production.rst | 11 +++++++++++ docs/reference.rst | 10 ++++++++++ docs/train.rst | 11 +++++++++++ runtime/binding/python/README.md | 2 +- 6 files changed, 46 insertions(+), 21 deletions(-) create mode 100644 docs/production.rst create mode 100644 docs/reference.rst create mode 100644 docs/train.rst diff --git a/docs/conf.py b/docs/conf.py index 49abc1071..1a597982c 100644 --- 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 index 9eb920f3c..4f8c53ab2 100644 --- 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 new file mode 100644 index 000000000..b795ccd75 --- /dev/null +++ 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 new file mode 100644 index 000000000..1b9c3194e --- /dev/null +++ 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 new file mode 100644 index 000000000..6abab2781 --- /dev/null +++ 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 index b5a86ff85..993e65cb0 100644 --- 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.