[Doc]: refactor doc directory (#1743)

* refactor en doc dir * add rst for en * fix rest * add chs * fix lint

[Doc]: refactor doc directory (#1743)
* refactor en doc dir * add rst for en * fix rest * add chs * fix lint
009d5d6e · Shilong Zhang · GitHub · 6fa8850e · 6fa8850e · 009d5d6e
Unverified Commit 009d5d6e authored Aug 22, 2022 by Shilong Zhang Committed by GitHub Aug 22, 2022
20 changed files
--- a/docs/en/_static/image/mmdet3d-logo.png
+++ b/docs/en/_static/image/mmdet3d-logo.png
--- a/docs/en/tutorials/customize_dataset.md
+++ b/docs/en/tutorials/customize_dataset.md
-# Tutorial 2: Customize Datasets
+# Customize Datasets
 ## Support new data format

--- a/docs/en/tutorials/customize_models.md
+++ b/docs/en/tutorials/customize_models.md
-# Tutorial 4: Customize Models
+# Customize Models
 We basically categorize model components into 6 types.

--- a/docs/en/tutorials/customize_runtime.md
+++ b/docs/en/tutorials/customize_runtime.md
-# Tutorial 5: Customize Runtime Settings
+# Customize Runtime Settings
 ## Customize optimization settings

--- a/docs/en/datasets/index.rst
+++ b/docs/en/datasets/index.rst
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
   kitti_det.md
   nuscenes_det.md

--- a/docs/en/datasets/kitti_det.md
+++ b/docs/en/datasets/kitti_det.md
--- a/docs/en/datasets/lyft_det.md
+++ b/docs/en/datasets/lyft_det.md
--- a/docs/en/datasets/nuscenes_det.md
+++ b/docs/en/datasets/nuscenes_det.md
--- a/docs/en/datasets/s3dis_sem_seg.md
+++ b/docs/en/datasets/s3dis_sem_seg.md
--- a/docs/en/datasets/scannet_det.md
+++ b/docs/en/datasets/scannet_det.md
--- a/docs/en/datasets/scannet_sem_seg.md
+++ b/docs/en/datasets/scannet_sem_seg.md
--- a/docs/en/datasets/sunrgbd_det.md
+++ b/docs/en/datasets/sunrgbd_det.md
--- a/docs/en/datasets/waymo_det.md
+++ b/docs/en/datasets/waymo_det.md
--- a/docs/en/advanced_guides/index.rst
+++ b/docs/en/advanced_guides/index.rst
+.. toctree::
+   :maxdepth: 1
+   :caption: Datasets
+   datasets/index.rst
+.. toctree::
+   :maxdepth: 1
+   :caption: Supported Tasks
+   supported_tasks/index.rst
+.. toctree::
+   :maxdepth: 1
+   customize_dataset.md
+   customize_models.md
+   customize_runtime.md
--- a/docs/en/tutorials/pure_point_cloud_dataset.md
+++ b/docs/en/tutorials/pure_point_cloud_dataset.md
-# Tutorial 9: Use Pure Point Cloud Dataset
+# Use Pure Point Cloud Dataset
 ## Data Pre-Processing

--- a/docs/zh_cn/supported_tasks/index.rst
+++ b/docs/zh_cn/supported_tasks/index.rst
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
   lidar_det3d.md
   vision_det3d.md

--- a/docs/en/supported_tasks/lidar_det3d.md
+++ b/docs/en/supported_tasks/lidar_det3d.md
--- a/docs/en/supported_tasks/lidar_sem_seg3d.md
+++ b/docs/en/supported_tasks/lidar_sem_seg3d.md
--- a/docs/en/supported_tasks/vision_det3d.md
+++ b/docs/en/supported_tasks/vision_det3d.md
--- a/docs/en/index.rst
+++ b/docs/en/index.rst
@@ -5,88 +5,49 @@ Welcome to MMDetection3D's documentation!
   :maxdepth: 1
   :caption: Get Started
+   overview.md
   getting_started.md
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
-   :caption: Demo
+   :caption: User Guides
-   demo.md
-.. toctree::
-   :maxdepth: 1
-   :caption: Model Zoo
-   model_zoo.md
+   user_guides/index.rst
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
-   :caption: Data Preparation
+   :caption: Advanced Guides
-   data_preparation.md
+   advanced_guides/index.rst
 .. toctree::
   :maxdepth: 1
-   :caption: Exist Data and Model
+   :caption: Migration
-   1_exist_data_model.md
+   migration.md
 .. toctree::
   :maxdepth: 1
-   :caption: New Data and Model
+   :caption: API Reference
-   2_new_data_model.md
-.. toctree::
-   :maxdepth: 1
-   :caption: Supported Tasks
-   supported_tasks/index.rst
-.. toctree::
-   :maxdepth: 1
-   :caption: Datasets
-   datasets/index.rst
+   api.rst
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
-   :caption: Tutorials
+   :caption: Model Zoo
-   tutorials/index.rst
-.. toctree::
+   model_zoo.md
-   :maxdepth: 1
-   :caption: Useful Tools and Scripts
-   useful_tools.md
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
   :caption: Notes
-   benchmarks.md
+   notes/index.rst
-.. toctree::
-   :maxdepth: 1
-   :caption: FAQ
-   faq.md
 .. toctree::
-   :maxdepth: 1
-   :caption: Compatibility
-   compatibility.md
-.. toctree::
-   :maxdepth: 1
-   :caption: API Reference
-   api.rst
-.. toctree::
-   :maxdepth: 1
   :caption: Switch Language
   switch_language.md