[Refactor] Refactor the doc structure (open-mmlab#1786)

* fix structure * add version for m2r * read docs * add log * api.rst * fix api.rst * fix the doc
MasatoSaeki · Aug 31, 2022 · 7dfaf22 · 7dfaf22
1 parent c2d958a
commit 7dfaf22
Show file tree

Hide file tree

Showing 21 changed files with 247 additions and 203 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -6,5 +6,4 @@ python:
   version: 3.7
   install:
     - requirements: requirements/docs.txt
-    - requirements: requirements/runtime.txt
     - requirements: requirements/readthedocs.txt
diff --git a/docs/en/_static/image/mmdet3d-logo.png b/docs/en/_static/image/mmdet3d-logo.png
diff --git a/docs/en/advanced_guides/index.rst b/docs/en/advanced_guides/index.rst
@@ -1,18 +1,26 @@
+Datasets
+**************
+
 .. toctree::
    :maxdepth: 1
-   :caption: Datasets
 
    datasets/index.rst
 
+
+Supported Tasks
+**************
+
 .. toctree::
-   :maxdepth: 1
-   :caption: Supported Tasks
+   :maxdepth: 2
 
    supported_tasks/index.rst
 
 
+Customization
+**************
+
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    customize_dataset.md
    customize_models.md

diff --git a/docs/en/api.rst b/docs/en/api.rst
@@ -1,73 +1,76 @@
-mmdet3d.core
+mmdet3d.apis
 --------------
+.. automodule:: mmdet3d.apis
+    :members:
 
-anchor
+mmdet3d.datasets
+--------------
+
+datasets
 ^^^^^^^^^^
-.. automodule:: mmdet3d.core.anchor
+.. automodule:: mmdet3d.datasets
     :members:
 
-bbox
-^^^^^^^^^^
-.. automodule:: mmdet3d.core.bbox
+
+transforms
+^^^^^^^^^^^^
+.. automodule:: mmdet3d.datasets.transforms
     :members:
 
-evaluation
+mmdet3d.engine
+--------------
+
+schedulers
 ^^^^^^^^^^
-.. automodule:: mmdet3d.core.evaluation
+.. automodule:: mmdet3d.engine.schedulers
     :members:
 
-visualizer
-^^^^^^^^^^^^^^^
-.. automodule:: mmdet3d.core.visualizer
-    :members:
+mmdet3d.evaluation
+--------------
 
-voxel
-^^^^^^^^^^^^^^^
-.. automodule:: mmdet3d.core.voxel
+functional
+^^^^^^^^^^
+.. automodule:: mmdet3d.engine.functional
     :members:
 
-post_processing
-^^^^^^^^^^^^^^^
-.. automodule:: mmdet3d.core.post_processing
+metrics
+^^^^^^^^^^
+.. automodule:: mmdet3d.engine.metrics
     :members:
 
-mmdet3d.datasets
-----------------
-
-.. automodule:: mmdet3d.datasets
-    :members:
 
 mmdet3d.models
 --------------
 
-detectors
-^^^^^^^^^^
-.. automodule:: mmdet3d.models.detectors
-    :members:
-
 backbones
 ^^^^^^^^^^
 .. automodule:: mmdet3d.models.backbones
     :members:
 
-necks
+data_preprocessors
 ^^^^^^^^^^
-.. automodule:: mmdet3d.models.necks
+.. automodule:: mmdet3d.models.data_preprocessors
     :members:
 
+decode_heads
+^^^^^^^^^^^^
+.. automodule:: mmdet3d.models.decode_heads
+    :members:
+
+
 dense_heads
 ^^^^^^^^^^^^
 .. automodule:: mmdet3d.models.dense_heads
     :members:
 
-roi_heads
+detectors
 ^^^^^^^^^^
-.. automodule:: mmdet3d.models.roi_heads
+.. automodule:: mmdet3d.models.detectors
     :members:
 
-fusion_layers
-^^^^^^^^^^^^^
-.. automodule:: mmdet3d.models.fusion_layers
+layers
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.layers
     :members:
 
 losses
@@ -76,11 +79,74 @@ losses
     :members:
 
 middle_encoders
-^^^^^^^^^^^^^^^
+^^^^^^^^^^^^
 .. automodule:: mmdet3d.models.middle_encoders
     :members:
 
-model_utils
-^^^^^^^^^^^^^
-.. automodule:: mmdet3d.models.model_utils
+necks
+^^^^^^^^^^^^
+.. automodule:: mmdet3d.models.necks
+    :members:
+
+roi_heads
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.roi_heads
+    :members:
+
+segmentors
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.segmentors
+    :members:
+
+task_modules
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.task_modules
+    :members:
+
+test_time_augs
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.test_time_augs
+    :members:
+
+utils
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.utils
+    :members:
+
+voxel_encoders
+^^^^^^^^^^
+.. automodule:: mmdet3d.models.voxel_encoders
+    :members:
+
+mmdet3d.structures
+--------------
+
+structures
+^^^^^^^^^^
+.. automodule:: mmdet3d.structures
+    :members:
+
+bbox_3d
+^^^^^^^^^^
+.. automodule:: mmdet3d.structures.bbox_3d
+    :members:
+
+ops
+^^^^^^^^^^
+.. automodule:: mmdet3d.structures.ops
+    :members:
+
+points
+^^^^^^^^^^
+.. automodule:: mmdet3d.structures.points
+    :members:
+
+mmdet3d.utils
+--------------
+.. automodule::mmdet3d.utils
+    :members:
+
+mmdet3d.visulization
+--------------
+.. automodule::mmdet3d.visulization
     :members:
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -9,7 +9,7 @@ Welcome to MMDetection3D's documentation!
    getting_started.md
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: User Guides
 
    user_guides/index.rst
@@ -40,7 +40,7 @@ Welcome to MMDetection3D's documentation!
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Notes
 
    notes/index.rst

diff --git a/docs/en/notes/changelog.md b/docs/en/notes/changelog.md
@@ -1,4 +1,4 @@
-## Changelog
+# Changelog
 
 ### v1.0.0rc3 (8/6/2022)
 

diff --git a/docs/en/notes/compatibility.md b/docs/en/notes/compatibility.md
@@ -1,3 +1,5 @@
+# Compatibility
+
 ## v1.0.0rc1
 
 ### Operators Migration

diff --git a/docs/en/notes/index.rst b/docs/en/notes/index.rst
@@ -1,5 +1,5 @@
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 1
 
    benchmarks.md
    changelog.md

diff --git a/docs/en/user_guides/1_exist_data_model.md b/docs/en/user_guides/1_exist_data_model.md
@@ -1,4 +1,4 @@
-# 1: Inference and train with existing models and standard datasets
+# Inference and train
 
 ## Inference with existing models
 

diff --git a/docs/en/user_guides/2_new_data_model.md b/docs/en/user_guides/2_new_data_model.md
diff --git a/docs/en/user_guides/backends_support.md b/docs/en/user_guides/backends_support.md
@@ -1,4 +1,4 @@
-# Tutorial 7: Backends Support
+# Backends Support
 
 We support different file client backends: Disk, Ceph and LMDB, etc. Here is an example of how to modify configs for Ceph-based data loading and saving.
 

diff --git a/docs/en/user_guides/config.md b/docs/en/user_guides/config.md
@@ -1,4 +1,4 @@
-# Tutorial 1: Learn about Configs
+# Learn about Configs
 
 We incorporate modular and inheritance design into our config system, which is convenient to conduct various experiments.
 If you wish to inspect the config file, you may run `python tools/misc/print_config.py /PATH/TO/CONFIG` to see the complete config.

diff --git a/docs/en/user_guides/coord_sys_tutorial.md b/docs/en/user_guides/coord_sys_tutorial.md
@@ -1,4 +1,4 @@
-# Tutorial 6: Coordinate System
+# Coordinate System
 
 ## Overview
 

diff --git a/docs/en/user_guides/data_pipeline.md b/docs/en/user_guides/data_pipeline.md
@@ -1,4 +1,4 @@
-# Tutorial 3: Customize Data Pipelines
+# Customize Data Pipelines
 
 ## Design of Data pipelines