From d505ec1c949f0c4d9f54e62f473ea7b720ce5332 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=B0=A2=E6=98=95=E8=BE=B0?= <xiexinch@outlook.com>
Date: Fri, 13 Jan 2023 20:06:30 +0800
Subject: [PATCH] [Doc] Fix API document (#2483)

## Motivation

As title.

## Modification

- docs/en/api.rst
- docs/zh_cn/api.rst
- add `scipy` to readthedocs requirement.
---
 docs/en/api.rst              | 60 +++++++++++++++++-------------------
 docs/zh_cn/api.rst           | 58 ++++++++++++++++------------------
 requirements/readthedocs.txt |  5 +--
 3 files changed, 58 insertions(+), 65 deletions(-)

diff --git a/docs/en/api.rst b/docs/en/api.rst
index 12ec13b2b..94f64313d 100644
--- a/docs/en/api.rst
+++ b/docs/en/api.rst
@@ -11,8 +11,13 @@ datasets
 .. automodule:: mmseg.datasets
     :members:
 
-transforms
+samplers
 ^^^^^^^^^^
+.. automodule:: mmseg.datasets.samplers
+    :members:
+
+transforms
+^^^^^^^^^^^^
 .. automodule:: mmseg.datasets.transforms
     :members:
 
@@ -25,12 +30,12 @@ hooks
     :members:
 
 optimizers
-^^^^^^^^^^
+^^^^^^^^^^^^^^^
 .. automodule:: mmseg.engine.optimizers
     :members:
 
 mmseg.evaluation
------------------
+--------------
 
 metrics
 ^^^^^^^^^^
@@ -40,9 +45,14 @@ metrics
 mmseg.models
 --------------
 
-models
-^^^^^^^^^^
-.. automodule:: mmseg.models
+backbones
+^^^^^^^^^^^^^^^^^^
+.. automodule:: mmseg.models.backbones
+    :members:
+
+decode_heads
+^^^^^^^^^^^^^^^
+.. automodule:: mmseg.models.decode_heads
     :members:
 
 segmentors
@@ -50,41 +60,27 @@ segmentors
 .. automodule:: mmseg.models.segmentors
     :members:
 
-backbones
-^^^^^^^^^^
-.. automodule:: mmseg.models.backbones
-    :members:
-
-decode_heads
-^^^^^^^^^^^^
-.. automodule:: mmseg.models.decode_heads
-    :members:
-
 losses
 ^^^^^^^^^^
 .. automodule:: mmseg.models.losses
     :members:
 
+necks
+^^^^^^^^^^^^
+.. automodule:: mmseg.models.necks
+    :members:
+
 utils
 ^^^^^^^^^^
 .. automodule:: mmseg.models.utils
     :members:
 
-necks
-^^^^^^^^^^
-.. automodule:: mmseg.models.necks
-    :members:
-
-mmseg.registry
---------------
-.. automodule:: mmseg.registry
-    :members:
 
 mmseg.structures
------------------
+--------------------
 
 structures
-^^^^^^^^^^
+^^^^^^^^^^^^^^^^^
 .. automodule:: mmseg.structures
     :members:
 
@@ -93,12 +89,12 @@ sampler
 .. automodule:: mmseg.structures.sampler
     :members:
 
+mmseg.visualization
+--------------------
+.. automodule:: mmseg.visualization
+    :members:
+
 mmseg.utils
 --------------
 .. automodule:: mmseg.utils
     :members:
-
-mmseg.visualization
-----------------------
-.. automodule:: mmseg.visualization
-    :members:
diff --git a/docs/zh_cn/api.rst b/docs/zh_cn/api.rst
index be68c7579..94f64313d 100644
--- a/docs/zh_cn/api.rst
+++ b/docs/zh_cn/api.rst
@@ -11,8 +11,13 @@ datasets
 .. automodule:: mmseg.datasets
     :members:
 
-transforms
+samplers
 ^^^^^^^^^^
+.. automodule:: mmseg.datasets.samplers
+    :members:
+
+transforms
+^^^^^^^^^^^^
 .. automodule:: mmseg.datasets.transforms
     :members:
 
@@ -25,7 +30,7 @@ hooks
     :members:
 
 optimizers
-^^^^^^^^^^
+^^^^^^^^^^^^^^^
 .. automodule:: mmseg.engine.optimizers
     :members:
 
@@ -40,9 +45,14 @@ metrics
 mmseg.models
 --------------
 
-models
-^^^^^^^^^^
-.. automodule:: mmseg.models
+backbones
+^^^^^^^^^^^^^^^^^^
+.. automodule:: mmseg.models.backbones
+    :members:
+
+decode_heads
+^^^^^^^^^^^^^^^
+.. automodule:: mmseg.models.decode_heads
     :members:
 
 segmentors
@@ -50,41 +60,27 @@ segmentors
 .. automodule:: mmseg.models.segmentors
     :members:
 
-backbones
-^^^^^^^^^^
-.. automodule:: mmseg.models.backbones
-    :members:
-
-decode_heads
-^^^^^^^^^^^^
-.. automodule:: mmseg.models.decode_heads
-    :members:
-
 losses
 ^^^^^^^^^^
 .. automodule:: mmseg.models.losses
     :members:
 
+necks
+^^^^^^^^^^^^
+.. automodule:: mmseg.models.necks
+    :members:
+
 utils
 ^^^^^^^^^^
 .. automodule:: mmseg.models.utils
     :members:
 
-necks
-^^^^^^^^^^
-.. automodule:: mmseg.models.necks
-    :members:
-
-mmseg.registry
---------------
-.. automodule:: mmseg.registry
-    :members:
 
 mmseg.structures
---------------
+--------------------
 
 structures
-^^^^^^^^^^
+^^^^^^^^^^^^^^^^^
 .. automodule:: mmseg.structures
     :members:
 
@@ -93,12 +89,12 @@ sampler
 .. automodule:: mmseg.structures.sampler
     :members:
 
+mmseg.visualization
+--------------------
+.. automodule:: mmseg.visualization
+    :members:
+
 mmseg.utils
 --------------
 .. automodule:: mmseg.utils
     :members:
-
-mmseg.visualization
---------------
-.. automodule:: mmseg.visualization
-    :members:
diff --git a/requirements/readthedocs.txt b/requirements/readthedocs.txt
index af6029b9a..1b5d8443b 100644
--- a/requirements/readthedocs.txt
+++ b/requirements/readthedocs.txt
@@ -1,5 +1,6 @@
-mmcv>=2.0.0rc0
-mmengine
+mmcv>=2.0.0rc1,<2.1.0
+mmengine>=0.1.0,<1.0.0
 prettytable
+scipy
 torch
 torchvision