refactor documentations (#6774)

open-mmlab · Dec 14, 2021 · e1fcad9 · e1fcad9
1 parent cc721ee
commit e1fcad9
Show file tree

Hide file tree

Showing 63 changed files with 6 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -64,7 +64,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs/en/_build/
+docs/zh_cn/_build/
 
 # PyBuilder
 target/

diff --git a/docs/1_exist_data_model.md → docs/en/1_exist_data_model.md b/docs/1_exist_data_model.md → docs/en/1_exist_data_model.md
diff --git a/docs/2_new_data_model.md → docs/en/2_new_data_model.md b/docs/2_new_data_model.md → docs/en/2_new_data_model.md
diff --git a/docs/3_exist_data_new_model.md → docs/en/3_exist_data_new_model.md b/docs/3_exist_data_new_model.md → docs/en/3_exist_data_new_model.md
diff --git a/docs/Makefile → docs/en/Makefile b/docs/Makefile → docs/en/Makefile
diff --git a/docs/_static/css/readthedocs.css → docs/en/_static/css/readthedocs.css b/docs/_static/css/readthedocs.css → docs/en/_static/css/readthedocs.css
diff --git a/docs/_static/image/mmdet-logo.png → docs/en/_static/image/mmdet-logo.png b/docs/_static/image/mmdet-logo.png → docs/en/_static/image/mmdet-logo.png
diff --git a/docs/api.rst → docs/en/api.rst b/docs/api.rst → docs/en/api.rst
diff --git a/docs/changelog.md → docs/en/changelog.md b/docs/changelog.md → docs/en/changelog.md
diff --git a/docs/compatibility.md → docs/en/compatibility.md b/docs/compatibility.md → docs/en/compatibility.md
diff --git a/docs/conf.py → docs/en/conf.py b/docs/conf.py → docs/en/conf.py
@@ -16,14 +16,14 @@
 
 import pytorch_sphinx_theme
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'MMDetection'
 copyright = '2018-2021, OpenMMLab'
 author = 'MMDetection Authors'
-version_file = '../mmdet/version.py'
+version_file = '../../mmdet/version.py'
 
 
 def get_version():

diff --git a/docs/conventions.md → docs/en/conventions.md b/docs/conventions.md → docs/en/conventions.md
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/model_zoo.md → docs/en/model_zoo.md b/docs/model_zoo.md → docs/en/model_zoo.md
diff --git a/docs/projects.md → docs/en/projects.md b/docs/projects.md → docs/en/projects.md
diff --git a/docs/robustness_benchmarking.md → docs/en/robustness_benchmarking.md b/docs/robustness_benchmarking.md → docs/en/robustness_benchmarking.md
diff --git a/docs/stat.py → docs/en/stat.py b/docs/stat.py → docs/en/stat.py
diff --git a/docs/switch_language.md → docs/en/switch_language.md b/docs/switch_language.md → docs/en/switch_language.md
diff --git a/docs/tutorials/config.md → docs/en/tutorials/config.md b/docs/tutorials/config.md → docs/en/tutorials/config.md
diff --git a/docs/tutorials/customize_dataset.md → docs/en/tutorials/customize_dataset.md b/docs/tutorials/customize_dataset.md → docs/en/tutorials/customize_dataset.md
diff --git a/docs/tutorials/customize_losses.md → docs/en/tutorials/customize_losses.md b/docs/tutorials/customize_losses.md → docs/en/tutorials/customize_losses.md
diff --git a/docs/tutorials/customize_models.md → docs/en/tutorials/customize_models.md b/docs/tutorials/customize_models.md → docs/en/tutorials/customize_models.md
diff --git a/docs/tutorials/customize_runtime.md → docs/en/tutorials/customize_runtime.md b/docs/tutorials/customize_runtime.md → docs/en/tutorials/customize_runtime.md
diff --git a/docs/tutorials/data_pipeline.md → docs/en/tutorials/data_pipeline.md b/docs/tutorials/data_pipeline.md → docs/en/tutorials/data_pipeline.md
diff --git a/docs/tutorials/finetune.md → docs/en/tutorials/finetune.md b/docs/tutorials/finetune.md → docs/en/tutorials/finetune.md
diff --git a/docs/tutorials/index.rst → docs/en/tutorials/index.rst b/docs/tutorials/index.rst → docs/en/tutorials/index.rst
diff --git a/docs/tutorials/init_cfg.md → docs/en/tutorials/init_cfg.md b/docs/tutorials/init_cfg.md → docs/en/tutorials/init_cfg.md
diff --git a/docs/tutorials/onnx2tensorrt.md → docs/en/tutorials/onnx2tensorrt.md b/docs/tutorials/onnx2tensorrt.md → docs/en/tutorials/onnx2tensorrt.md
diff --git a/docs/tutorials/pytorch2onnx.md → docs/en/tutorials/pytorch2onnx.md b/docs/tutorials/pytorch2onnx.md → docs/en/tutorials/pytorch2onnx.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/1_exist_data_model.md → docs/zh_cn/1_exist_data_model.md b/docs_zh-CN/1_exist_data_model.md → docs/zh_cn/1_exist_data_model.md
diff --git a/docs_zh-CN/2_new_data_model.md → docs/zh_cn/2_new_data_model.md b/docs_zh-CN/2_new_data_model.md → docs/zh_cn/2_new_data_model.md
diff --git a/docs_zh-CN/3_exist_data_new_model.md → docs/zh_cn/3_exist_data_new_model.md b/docs_zh-CN/3_exist_data_new_model.md → docs/zh_cn/3_exist_data_new_model.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 → docs/zh_cn/_static/css/readthedocs.css b/docs_zh-CN/_static/css/readthedocs.css → docs/zh_cn/_static/css/readthedocs.css
diff --git a/docs_zh-CN/_static/image/mmdet-logo.png → docs/zh_cn/_static/image/mmdet-logo.png b/docs_zh-CN/_static/image/mmdet-logo.png → docs/zh_cn/_static/image/mmdet-logo.png
diff --git a/docs_zh-CN/api.rst → docs/zh_cn/api.rst b/docs_zh-CN/api.rst → docs/zh_cn/api.rst
diff --git a/docs_zh-CN/compatibility.md → docs/zh_cn/compatibility.md b/docs_zh-CN/compatibility.md → docs/zh_cn/compatibility.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
@@ -16,14 +16,14 @@
 
 import pytorch_sphinx_theme
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../../'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'MMDetection'
 copyright = '2018-2021, OpenMMLab'
 author = 'MMDetection Authors'
-version_file = '../mmdet/version.py'
+version_file = '../../mmdet/version.py'
 
 
 def get_version():

diff --git a/docs_zh-CN/conventions.md → docs/zh_cn/conventions.md b/docs_zh-CN/conventions.md → docs/zh_cn/conventions.md
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/get_started.md → docs/zh_cn/get_started.md b/docs_zh-CN/get_started.md → docs/zh_cn/get_started.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/model_zoo.md → docs/zh_cn/model_zoo.md b/docs_zh-CN/model_zoo.md → docs/zh_cn/model_zoo.md
diff --git a/docs_zh-CN/projects.md → docs/zh_cn/projects.md b/docs_zh-CN/projects.md → docs/zh_cn/projects.md
diff --git a/docs_zh-CN/robustness_benchmarking.md → docs/zh_cn/robustness_benchmarking.md b/docs_zh-CN/robustness_benchmarking.md → docs/zh_cn/robustness_benchmarking.md
diff --git a/docs_zh-CN/stat.py → docs/zh_cn/stat.py b/docs_zh-CN/stat.py → docs/zh_cn/stat.py
diff --git a/docs_zh-CN/switch_language.md → docs/zh_cn/switch_language.md b/docs_zh-CN/switch_language.md → docs/zh_cn/switch_language.md
diff --git a/docs_zh-CN/tutorials/config.md → docs/zh_cn/tutorials/config.md b/docs_zh-CN/tutorials/config.md → docs/zh_cn/tutorials/config.md
diff --git a/docs_zh-CN/tutorials/customize_dataset.md → docs/zh_cn/tutorials/customize_dataset.md b/docs_zh-CN/tutorials/customize_dataset.md → docs/zh_cn/tutorials/customize_dataset.md
diff --git a/docs_zh-CN/tutorials/customize_losses.md → docs/zh_cn/tutorials/customize_losses.md b/docs_zh-CN/tutorials/customize_losses.md → docs/zh_cn/tutorials/customize_losses.md
diff --git a/docs_zh-CN/tutorials/customize_models.md → docs/zh_cn/tutorials/customize_models.md b/docs_zh-CN/tutorials/customize_models.md → docs/zh_cn/tutorials/customize_models.md
diff --git a/docs_zh-CN/tutorials/customize_runtime.md → docs/zh_cn/tutorials/customize_runtime.md b/docs_zh-CN/tutorials/customize_runtime.md → docs/zh_cn/tutorials/customize_runtime.md
diff --git a/docs_zh-CN/tutorials/data_pipeline.md → docs/zh_cn/tutorials/data_pipeline.md b/docs_zh-CN/tutorials/data_pipeline.md → docs/zh_cn/tutorials/data_pipeline.md
diff --git a/docs_zh-CN/tutorials/finetune.md → docs/zh_cn/tutorials/finetune.md b/docs_zh-CN/tutorials/finetune.md → docs/zh_cn/tutorials/finetune.md
diff --git a/docs_zh-CN/tutorials/index.rst → docs/zh_cn/tutorials/index.rst b/docs_zh-CN/tutorials/index.rst → docs/zh_cn/tutorials/index.rst
diff --git a/docs_zh-CN/tutorials/onnx2tensorrt.md → docs/zh_cn/tutorials/onnx2tensorrt.md b/docs_zh-CN/tutorials/onnx2tensorrt.md → docs/zh_cn/tutorials/onnx2tensorrt.md
diff --git a/docs_zh-CN/tutorials/pytorch2onnx.md → docs/zh_cn/tutorials/pytorch2onnx.md b/docs_zh-CN/tutorials/pytorch2onnx.md → docs/zh_cn/tutorials/pytorch2onnx.md
diff --git a/docs_zh-CN/useful_tools.md → docs/zh_cn/useful_tools.md b/docs_zh-CN/useful_tools.md → docs/zh_cn/useful_tools.md