[Doc] MMSeg 1.x Documentation (#1924)

* [Doc] MMSeg 1.x Documentation

* revise index

docs/en/advanced_guides/data_flow.md

@@ -0,0 +1 @@
+# Data Flow

docs/en/advanced_guides/datasets.md

@@ -0,0 +1 @@
+# Datasets

docs/en/advanced_guides/engine.md

@@ -0,0 +1 @@
+# Engine

docs/en/advanced_guides/evaluation.md

@@ -0,0 +1 @@
+# Evaluation

docs/en/advanced_guides/index.rst

@@ -0,0 +1,26 @@
+Basic Concepts
+***************
+
+.. toctree::
+   :maxdepth: 1
+
+   data_flow.md
+   structures.md
+   models.md
+   datasets.md
+   transforms.md
+   evaluation.md
+   engine.md
+   training_tricks.md
+
+Component Customization
+************************
+
+.. toctree::
+   :maxdepth: 1
+
+   add_modules.md
+   add_datasets.md
+   add_transforms.md
+   add_metrics.md
+   customize_runtime.md

docs/en/advanced_guides/models.md

@@ -0,0 +1 @@
+# Models

docs/en/advanced_guides/structures.md

@@ -0,0 +1 @@
+# Structures

docs/en/index.rst

@@ -1,17 +1,34 @@
 Welcome to MMSegmentation's documentation!
-=======================================
+===========================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Get Started
 
    get_started.md
 
 .. toctree::
-   :maxdepth: 1
-   :caption: Dataset Preparation
+   :maxdepth: 2
+   :caption: User Guides
 
-   dataset_prepare.md
+   user_guides/index.rst
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Advanced Guides
+
+   advanced_guides/index.rst
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Migration
+
+   migration.md
+
+.. toctree::
+   :caption: API Reference
+
+   api.rst
 
 .. toctree::
    :maxdepth: 1
@@ -21,26 +38,7 @@ Welcome to MMSegmentation's documentation!
    modelzoo_statistics.md
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Quick Run
-
-   train.md
-   inference.md
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Tutorials
-
-   tutorials/index.rst
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Useful Tools and Scripts
-
-   useful_tools.md
-
-.. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Notes
 
    changelog.md
@@ -51,10 +49,7 @@ Welcome to MMSegmentation's documentation!
 
    switch_language.md
 
-.. toctree::
-   :caption: API Reference
 
-   api.rst
 
 Indices and tables
 ==================

docs/en/migration.md

@@ -0,0 +1 @@
+# Migration from MMSegmentation 0.x

docs/en/tutorials/index.rst

@@ -1,9 +0,0 @@
-.. toctree::
-   :maxdepth: 2
-
-   config.md
-   customize_datasets.md
-   data_pipeline.md
-   customize_models.md
-   training_tricks.md
-   customize_runtime.md

docs/en/user_guides/index.rst

@@ -0,0 +1,19 @@
+Train & Test
+**************
+
+.. toctree::
+   :maxdepth: 1
+
+   1_config.md
+   2_dataset_prepare.md
+   3_inference.md
+   4_train_test.md
+
+Useful Tools
+*************
+
+.. toctree::
+   :maxdepth: 2
+
+   useful_tools.md
+   visualization.md

docs/en/user_guides/visualization.md

@@ -0,0 +1 @@
+# Visualization

requirements/docs.txt

@@ -1,6 +1,6 @@
 docutils==0.16.0
 myst-parser
--e git+https://github.com/gaotongxiao/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
+-e git+https://github.com/open-mmlab/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
 sphinx==4.0.2
 sphinx_copybutton
 sphinx_markdown_tables