[Docs] Refactor document structure (open-mmlab#310)

* Refactor docs * Fix path * Update logo
humu789 · Dec 21, 2021 · c1ed41c · c1ed41c
1 parent b060908
commit c1ed41c
Show file tree

Hide file tree

Showing 72 changed files with 43 additions and 40 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -12,7 +12,7 @@ Thanks for your bug report. We appreciate it a lot.
 **Checklist**
 
 1. I have searched related issues but cannot get the expected help.
-2. I have read the [FAQ documentation](https://github.com/grimoire/deploy_prototype/blob/master/docs/faq.md) but cannot get the expected help.
+2. I have read the [FAQ documentation](https://github.com/grimoire/deploy_prototype/blob/master/docs/en/faq.md) but cannot get the expected help.
 3. The bug has not been fixed in the latest version.
 
 **Describe the bug**

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,5 +2,5 @@ blank_issues_enabled: false
 
 contact_links:
   - name: Common Issues
-    url: https://github.com/grimoire/deploy_prototype/blob/master/docs/faq.md
+    url: https://github.com/grimoire/deploy_prototype/blob/master/docs/en/faq.md
     about: Check if your issue already has solutions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -11,7 +11,6 @@ on:
       - 'demo/**'
       - 'tools/**'
       - 'docs/**'
-      - 'docs_zh-CN/**'
 
 jobs:
   build_cpu:

diff --git a/.gitignore b/.gitignore
@@ -64,8 +64,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
-docs_zh_CN/_build/
+docs/en/_build/
+docs/zh_cn/_build/
 **/src/pytorch-sphinx-theme/
 
 # PyBuilder

diff --git a/README.md b/README.md
@@ -44,19 +44,19 @@ This project is released under the [Apache 2.0 license](LICENSE).
 
 ## Installation
 
-Please refer to [build.md](docs/build.md) for installation.
+Please refer to [build.md](docs/en/build.md) for installation.
 
 ## Getting Started
-Please see [getting_started.md](docs/get_started.md) for the basic usage of MMDeploy. We also provide other tutorials for:
-- [how to convert model](docs/tutorials/how_to_convert_model.md)
-- [how to write config](docs/tutorials/how_to_write_config.md)
-- [how to support new models](docs/tutorials/how_to_support_new_models.md)
-- [how to measure performance of models](docs/tutorials/how_to_measure_performance_of_models.md)
-- [MMDeploy's SDK Model spec](docs/tutorials/sdk_model_spec.md)
-- [how to integrate SDK to your application](docs/tutorials/sdk_integration.md)
-- [how to develop postprocessing components in SDK](docs/tutorials/postprocess_component_development.md)
-
-Please refer to [FAQ](docs/faq.md) for frequently asked questions.
+Please see [getting_started.md](docs/en/get_started.md) for the basic usage of MMDeploy. We also provide other tutorials for:
+- [how to convert model](docs/en/tutorials/how_to_convert_model.md)
+- [how to write config](docs/en/tutorials/how_to_write_config.md)
+- [how to support new models](docs/en/tutorials/how_to_support_new_models.md)
+- [how to measure performance of models](docs/en/tutorials/how_to_measure_performance_of_models.md)
+- [MMDeploy's SDK Model spec](docs/en/tutorials/sdk_model_spec.md)
+- [how to integrate SDK to your application](docs/en/tutorials/sdk_integration.md)
+- [how to develop postprocessing components in SDK](docs/en/tutorials/postprocess_component_development.md)
+
+Please refer to [FAQ](docs/en/faq.md) for frequently asked questions.
 
 
 ## Contributing

diff --git a/README_zh-CN.md b/README_zh-CN.md
@@ -41,15 +41,15 @@ MMDeploy 是一个开源深度学习模型部署工具箱，它是 [OpenMMLab](h
 
 ## 安装
 
-请参考[构建项目](docs/build.md)进行安装。
+请参考[构建项目](docs/zh_cn/build.md)进行安装。
 
 ## 快速入门
 
-请阅读 [如何进行模型转换](docs/tutorials/how_to_convert_model.md) 来了解基本的 MMDeploy 使用。
+请阅读 [如何进行模型转换](docs/zh_cn/tutorials/how_to_convert_model.md) 来了解基本的 MMDeploy 使用。
 
-我们还提供了诸如 [如何编写配置文件](docs/tutorials/how_to_write_config.md)， [如何添加新模型支持](docs/tutorials/how_to_support_new_models.md) 和 [如何测试模型效果](docs/tutorials/how_to_measure_performance_of_models.md) 等教程。
+我们还提供了诸如 [如何编写配置文件](docs/zh_cn/tutorials/how_to_write_config.md)， [如何添加新模型支持](docs/zh_cn/tutorials/how_to_support_new_models.md) 和 [如何测试模型效果](docs/zh_cn/tutorials/how_to_measure_performance_of_models.md) 等教程。
 
-如果遇到问题，请参考 [常见问题解答](docs/faq.md)。
+如果遇到问题，请参考 [常见问题解答](docs/zh_cn/faq.md)。
 
 ## 贡献指南
 

diff --git a/docs/_static/css/readthedocs.css b/docs/_static/css/readthedocs.css
diff --git a/docs/Makefile → docs/en/Makefile b/docs/Makefile → docs/en/Makefile
diff --git a/docs/en/_static/css/readthedocs.css b/docs/en/_static/css/readthedocs.css
@@ -0,0 +1,6 @@
+.header-logo {
+    background-image: url("../image/mmdeploy-logo.png");
+    background-size: 120px 60px;
+    height: 60px;
+    width: 120px;
+}
diff --git a/docs/en/_static/image/mmdeploy-logo.png b/docs/en/_static/image/mmdeploy-logo.png
diff --git a/docs_zh_CN/api.rst → docs/en/api.rst b/docs_zh_CN/api.rst → docs/en/api.rst
@@ -19,6 +19,6 @@ apis/ncnn
     :members:
 
 apis/pplnn
---------
+----------
 .. automodule:: mmdeploy.apis.pplnn
     :members:
diff --git a/docs/backends/ncnn.md → docs/en/backends/ncnn.md b/docs/backends/ncnn.md → docs/en/backends/ncnn.md
diff --git a/docs/backends/onnxruntime.md → docs/en/backends/onnxruntime.md b/docs/backends/onnxruntime.md → docs/en/backends/onnxruntime.md
@@ -56,11 +56,11 @@ make -j10
 
 ### List of supported custom ops
 
-| Operator                                                                     | CPU | GPU | MMDeploy Releases |
-|:-----------------------------------------------------------------------------|:---:|:---:|:------------------|
-| [RoIAlign](../ops/onnxruntime.md#roialign)                                   |  Y  |  N  | master            |
-| [grid_sampler](../ops/onnxruntime.md#grid_sampler)                           |  Y  |  N  | master            |
-| [MMCVModulatedDeformConv2d](../ops/onnxruntime.md#mmcvmodulateddeformconv2d) |  Y  |  N  | master            |
+| Operator                                                                     |  CPU  |  GPU  | MMDeploy Releases |
+| :--------------------------------------------------------------------------- | :---: | :---: | :---------------- |
+| [RoIAlign](../ops/onnxruntime.md#roialign)                                   |   Y   |   N   | master            |
+| [grid_sampler](../ops/onnxruntime.md#grid_sampler)                           |   Y   |   N   | master            |
+| [MMCVModulatedDeformConv2d](../ops/onnxruntime.md#mmcvmodulateddeformconv2d) |   Y   |   N   | master            |
 
 ### How to add a new custom op
 
@@ -76,7 +76,7 @@ Take custom operator `roi_align` for example.
 1. Create a `roi_align` directory in ONNX Runtime source directory `backend_ops/onnxruntime/`
 2. Add header and source file into `roi_align` directory `backend_ops/onnxruntime/roi_align/`
 3. Add unit test into `tests/test_ops/test_ops.py`
-   Check [here](../../tests/test_ops/test_ops.py) for examples.
+   Check [here](../../../tests/test_ops/test_ops.py) for examples.
 
 **Finally, welcome to send us PR of adding custom operators for ONNX Runtime in MMDeploy.** :nerd_face:
 

diff --git a/docs/backends/openvino.md → docs/en/backends/openvino.md b/docs/backends/openvino.md → docs/en/backends/openvino.md
diff --git a/docs/backends/pplnn.md → docs/en/backends/pplnn.md b/docs/backends/pplnn.md → docs/en/backends/pplnn.md
diff --git a/docs/backends/tensorrt.md → docs/en/backends/tensorrt.md b/docs/backends/tensorrt.md → docs/en/backends/tensorrt.md
diff --git a/docs/benchmark.md → docs/en/benchmark.md b/docs/benchmark.md → docs/en/benchmark.md
@@ -20,7 +20,7 @@ GPU: TensorRT, PPLNN
 - Input resolution varies for different datasets of different codebases. All inputs are real images except for mmediting because the dataset is not large enough.
 
 ### Latency benchmark
-Users can directly test the speed through [how_to_measure_performance_of_models.md](docs/tutorials/how_to_measure_performance_of_models.md). And here is the benchmark in our environment.
+Users can directly test the speed through [how_to_measure_performance_of_models.md](docs/en/tutorials/how_to_measure_performance_of_models.md). And here is the benchmark in our environment.
 <details>
 <summary style="margin-left: 25px;">MMCls with 1x3x224x224 input</summary>
 <div style="margin-left: 25px;">
@@ -477,7 +477,7 @@ Users can directly test the speed through [how_to_measure_performance_of_models.
 
 ### Performance benchmark
 
-Users can directly test the performance through [how_to_evaluate_a_model.md](docs/tutorials/how_to_evaluate_a_model.md). And here is the benchmark in our environment.
+Users can directly test the performance through [how_to_evaluate_a_model.md](docs/en/tutorials/how_to_evaluate_a_model.md). And here is the benchmark in our environment.
 
 <details>
 <summary style="margin-left: 25px;">MMClassification</summary>

diff --git a/docs/build.md → docs/en/build.md b/docs/build.md → docs/en/build.md
diff --git a/docs/codebases/mmcls.md → docs/en/codebases/mmcls.md b/docs/codebases/mmcls.md → docs/en/codebases/mmcls.md
diff --git a/docs/codebases/mmdet.md → docs/en/codebases/mmdet.md b/docs/codebases/mmdet.md → docs/en/codebases/mmdet.md
diff --git a/docs/codebases/mmedit.md → docs/en/codebases/mmedit.md b/docs/codebases/mmedit.md → docs/en/codebases/mmedit.md
diff --git a/docs/codebases/mmocr.md → docs/en/codebases/mmocr.md b/docs/codebases/mmocr.md → docs/en/codebases/mmocr.md
diff --git a/docs/codebases/mmseg.md → docs/en/codebases/mmseg.md b/docs/codebases/mmseg.md → docs/en/codebases/mmseg.md
diff --git a/docs/conf.py → docs/en/conf.py b/docs/conf.py → docs/en/conf.py
@@ -21,7 +21,7 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-version_file = '../mmdeploy/version.py'
+version_file = '../../mmdeploy/version.py'
 with open(version_file, 'r') as f:
     exec(compile(f.read(), version_file, 'exec'))
 __version__ = locals()['__version__']

diff --git a/docs/faq.md → docs/en/faq.md b/docs/faq.md → docs/en/faq.md
diff --git a/docs/get_started.md → docs/en/get_started.md b/docs/get_started.md → docs/en/get_started.md
diff --git a/docs/index.rst → docs/en/index.rst b/docs/index.rst → docs/en/index.rst
diff --git a/docs/make.bat → docs/en/make.bat b/docs/make.bat → docs/en/make.bat
diff --git a/docs/ops/ncnn.md → docs/en/ops/ncnn.md b/docs/ops/ncnn.md → docs/en/ops/ncnn.md
diff --git a/docs/ops/onnxruntime.md → docs/en/ops/onnxruntime.md b/docs/ops/onnxruntime.md → docs/en/ops/onnxruntime.md
diff --git a/docs/ops/tensorrt.md → docs/en/ops/tensorrt.md b/docs/ops/tensorrt.md → docs/en/ops/tensorrt.md
diff --git a/.../how_to_add_test_units_for_backend_ops.md → .../how_to_add_test_units_for_backend_ops.md b/.../how_to_add_test_units_for_backend_ops.md → .../how_to_add_test_units_for_backend_ops.md
diff --git a/docs/tutorials/how_to_convert_model.md → docs/en/tutorials/how_to_convert_model.md b/docs/tutorials/how_to_convert_model.md → docs/en/tutorials/how_to_convert_model.md
diff --git a/docs/tutorials/how_to_evaluate_a_model.md → docs/en/tutorials/how_to_evaluate_a_model.md b/docs/tutorials/how_to_evaluate_a_model.md → docs/en/tutorials/how_to_evaluate_a_model.md
diff --git a/...s/how_to_measure_performance_of_models.md → ...s/how_to_measure_performance_of_models.md b/...s/how_to_measure_performance_of_models.md → ...s/how_to_measure_performance_of_models.md
diff --git a/.../tutorials/how_to_support_new_backends.md → .../tutorials/how_to_support_new_backends.md b/.../tutorials/how_to_support_new_backends.md → .../tutorials/how_to_support_new_backends.md
diff --git a/docs/tutorials/how_to_support_new_models.md → ...en/tutorials/how_to_support_new_models.md b/docs/tutorials/how_to_support_new_models.md → ...en/tutorials/how_to_support_new_models.md
diff --git a/...tutorials/how_to_test_rewritten_models.md → ...tutorials/how_to_test_rewritten_models.md b/...tutorials/how_to_test_rewritten_models.md → ...tutorials/how_to_test_rewritten_models.md
diff --git a/docs/tutorials/how_to_write_config.md → docs/en/tutorials/how_to_write_config.md b/docs/tutorials/how_to_write_config.md → docs/en/tutorials/how_to_write_config.md
diff --git a/...ials/postprocess_component_development.md → ...ials/postprocess_component_development.md b/...ials/postprocess_component_development.md → ...ials/postprocess_component_development.md
diff --git a/docs/tutorials/sdk_integration.md → docs/en/tutorials/sdk_integration.md b/docs/tutorials/sdk_integration.md → docs/en/tutorials/sdk_integration.md
diff --git a/docs/tutorials/sdk_model_spec.md → docs/en/tutorials/sdk_model_spec.md b/docs/tutorials/sdk_model_spec.md → docs/en/tutorials/sdk_model_spec.md
diff --git a/docs/useful_tools.md → docs/en/useful_tools.md b/docs/useful_tools.md → docs/en/useful_tools.md
diff --git a/docs_zh_CN/Makefile → docs/zh_cn/Makefile b/docs_zh_CN/Makefile → docs/zh_cn/Makefile
diff --git a/docs/zh_cn/_static/css/readthedocs.css b/docs/zh_cn/_static/css/readthedocs.css
@@ -0,0 +1,6 @@
+.header-logo {
+    background-image: url("../image/mmdeploy-logo.png");
+    background-size: 120px 60px;
+    height: 60px;
+    width: 120px;
+}
diff --git a/docs/zh_cn/_static/image/mmdeploy-logo.png b/docs/zh_cn/_static/image/mmdeploy-logo.png
diff --git a/docs/api.rst → docs/zh_cn/api.rst b/docs/api.rst → docs/zh_cn/api.rst
@@ -19,6 +19,6 @@ apis/ncnn
     :members:
 
 apis/pplnn
---------
+----------
 .. automodule:: mmdeploy.apis.pplnn
     :members:
diff --git a/docs_zh_CN/backends/ncnn.md → docs/zh_cn/backends/ncnn.md b/docs_zh_CN/backends/ncnn.md → docs/zh_cn/backends/ncnn.md
diff --git a/docs_zh_CN/backends/onnxruntime.md → docs/zh_cn/backends/onnxruntime.md b/docs_zh_CN/backends/onnxruntime.md → docs/zh_cn/backends/onnxruntime.md
diff --git a/docs_zh_CN/backends/pplnn.md → docs/zh_cn/backends/pplnn.md b/docs_zh_CN/backends/pplnn.md → docs/zh_cn/backends/pplnn.md
diff --git a/docs_zh_CN/backends/tensorrt.md → docs/zh_cn/backends/tensorrt.md b/docs_zh_CN/backends/tensorrt.md → docs/zh_cn/backends/tensorrt.md
diff --git a/docs_zh_CN/build.md → docs/zh_cn/build.md b/docs_zh_CN/build.md → docs/zh_cn/build.md
diff --git a/docs_zh_CN/codebases/mmcls.md → docs/zh_cn/codebases/mmcls.md b/docs_zh_CN/codebases/mmcls.md → docs/zh_cn/codebases/mmcls.md
diff --git a/docs_zh_CN/codebases/mmdet.md → docs/zh_cn/codebases/mmdet.md b/docs_zh_CN/codebases/mmdet.md → docs/zh_cn/codebases/mmdet.md
diff --git a/docs_zh_CN/codebases/mmedit.md → docs/zh_cn/codebases/mmedit.md b/docs_zh_CN/codebases/mmedit.md → docs/zh_cn/codebases/mmedit.md
diff --git a/docs_zh_CN/codebases/mmocr.md → docs/zh_cn/codebases/mmocr.md b/docs_zh_CN/codebases/mmocr.md → docs/zh_cn/codebases/mmocr.md
diff --git a/docs_zh_CN/codebases/mmseg.md → docs/zh_cn/codebases/mmseg.md b/docs_zh_CN/codebases/mmseg.md → docs/zh_cn/codebases/mmseg.md
diff --git a/docs_zh_CN/conf.py → docs/zh_cn/conf.py b/docs_zh_CN/conf.py → docs/zh_cn/conf.py
@@ -21,7 +21,7 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-version_file = '../mmdeploy/version.py'
+version_file = '../../mmdeploy/version.py'
 with open(version_file, 'r') as f:
     exec(compile(f.read(), version_file, 'exec'))
 __version__ = locals()['__version__']

diff --git a/docs_zh_CN/faq.md → docs/zh_cn/faq.md b/docs_zh_CN/faq.md → docs/zh_cn/faq.md
diff --git a/docs_zh_CN/index.rst → docs/zh_cn/index.rst b/docs_zh_CN/index.rst → docs/zh_cn/index.rst
diff --git a/docs_zh_CN/make.bat → docs/zh_cn/make.bat b/docs_zh_CN/make.bat → docs/zh_cn/make.bat
diff --git a/docs_zh_CN/ops/ncnn.md → docs/zh_cn/ops/ncnn.md b/docs_zh_CN/ops/ncnn.md → docs/zh_cn/ops/ncnn.md
diff --git a/docs_zh_CN/ops/onnxruntime.md → docs/zh_cn/ops/onnxruntime.md b/docs_zh_CN/ops/onnxruntime.md → docs/zh_cn/ops/onnxruntime.md
diff --git a/docs_zh_CN/ops/tensorrt.md → docs/zh_cn/ops/tensorrt.md b/docs_zh_CN/ops/tensorrt.md → docs/zh_cn/ops/tensorrt.md
diff --git a/.../how_to_add_test_units_for_backend_ops.md → .../how_to_add_test_units_for_backend_ops.md b/.../how_to_add_test_units_for_backend_ops.md → .../how_to_add_test_units_for_backend_ops.md
diff --git a/docs_zh_CN/tutorials/how_to_convert_model.md → docs/zh_cn/tutorials/how_to_convert_model.md b/docs_zh_CN/tutorials/how_to_convert_model.md → docs/zh_cn/tutorials/how_to_convert_model.md
diff --git a/...h_CN/tutorials/how_to_evaluate_a_model.md → ...h_cn/tutorials/how_to_evaluate_a_model.md b/...h_CN/tutorials/how_to_evaluate_a_model.md → ...h_cn/tutorials/how_to_evaluate_a_model.md
diff --git a/...CN/tutorials/how_to_support_new_models.md → ...cn/tutorials/how_to_support_new_models.md b/...CN/tutorials/how_to_support_new_models.md → ...cn/tutorials/how_to_support_new_models.md
diff --git a/docs_zh_CN/tutorials/how_to_test_model.md → docs/zh_cn/tutorials/how_to_test_model.md b/docs_zh_CN/tutorials/how_to_test_model.md → docs/zh_cn/tutorials/how_to_test_model.md
diff --git a/...tutorials/how_to_test_rewritten_models.md → ...tutorials/how_to_test_rewritten_models.md b/...tutorials/how_to_test_rewritten_models.md → ...tutorials/how_to_test_rewritten_models.md
diff --git a/docs_zh_CN/tutorials/how_to_write_config.md → docs/zh_cn/tutorials/how_to_write_config.md b/docs_zh_CN/tutorials/how_to_write_config.md → docs/zh_cn/tutorials/how_to_write_config.md
diff --git a/docs_zh_CN/_static b/docs_zh_CN/_static