Skip to content

Commit

Permalink
[Doc]: Fix the error that Readthedocs API cannot be displayed (#9510)
Browse files Browse the repository at this point in the history
* Fix the error that Readthedocs API cannot be displayed

* update

* update

* add scipy
  • Loading branch information
hhaAndroid authored Dec 19, 2022
1 parent 8f4360f commit fbd7edf
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 43 deletions.
48 changes: 27 additions & 21 deletions docs/en/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ datasets
:members:

api_wrappers
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.datasets.api_wrappers
:members:

Expand All @@ -28,13 +28,14 @@ transforms

mmdet.engine
--------------

hooks
^^^^^^^^^^
.. automodule:: mmdet.engine.hooks
:members:

optimizers
^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmdet.engine.optimizers
:members:

Expand All @@ -44,39 +45,39 @@ runner
:members:

schedulers
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.engine.schedulers
:members:

mmdet.evaluation
--------------
--------------------

functional
^^^^^^^^^^
.. automodule:: mmdet.engine.functional
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.evaluation.functional
:members:

metrics
^^^^^^^^^^
.. automodule:: mmdet.engine.metrics
.. automodule:: mmdet.evaluation.metrics
:members:


mmdet.models
--------------

backbones
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.backbones
:members:

data_preprocessors
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.data_preprocessors
:members:

dense_heads
^^^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.dense_heads
:members:

Expand All @@ -101,22 +102,22 @@ necks
:members:

roi_heads
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.roi_heads
:members:

seg_heads
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.seg_heads
:members:

task_modules
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.task_modules
:members:

test_time_augs
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.test_time_augs
:members:

Expand All @@ -127,7 +128,12 @@ utils


mmdet.structures
--------------
--------------------

structures
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.structures
:members:

bbox
^^^^^^^^^^
Expand All @@ -140,16 +146,16 @@ mask
:members:

mmdet.testing
--------------
.. automodule::mmdet.testing
----------------
.. automodule:: mmdet.testing
:members:

mmdet.visulization
--------------
.. automodule::mmdet.visulization
mmdet.visualization
--------------------
.. automodule:: mmdet.visualization
:members:

mmdet.utils
--------------
.. automodule::mmdet.utils
.. automodule:: mmdet.utils
:members:
48 changes: 27 additions & 21 deletions docs/zh_cn/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ datasets
:members:

api_wrappers
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.datasets.api_wrappers
:members:

Expand All @@ -28,13 +28,14 @@ transforms

mmdet.engine
--------------

hooks
^^^^^^^^^^
.. automodule:: mmdet.engine.hooks
:members:

optimizers
^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmdet.engine.optimizers
:members:

Expand All @@ -44,39 +45,39 @@ runner
:members:

schedulers
^^^^^^^^^^
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.engine.schedulers
:members:

mmdet.evaluation
--------------
--------------------

functional
^^^^^^^^^^
.. automodule:: mmdet.engine.functional
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.evaluation.functional
:members:

metrics
^^^^^^^^^^
.. automodule:: mmdet.engine.metrics
.. automodule:: mmdet.evaluation.metrics
:members:


mmdet.models
--------------

backbones
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.backbones
:members:

data_preprocessors
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.data_preprocessors
:members:

dense_heads
^^^^^^^^^^^^
^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.dense_heads
:members:

Expand All @@ -101,22 +102,22 @@ necks
:members:

roi_heads
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.roi_heads
:members:

seg_heads
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.seg_heads
:members:

task_modules
^^^^^^^^^^
^^^^^^^^^^^^^
.. automodule:: mmdet.models.task_modules
:members:

test_time_augs
^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.models.test_time_augs
:members:

Expand All @@ -127,7 +128,12 @@ utils


mmdet.structures
--------------
--------------------

structures
^^^^^^^^^^^^^^^^^
.. automodule:: mmdet.structures
:members:

bbox
^^^^^^^^^^
Expand All @@ -140,16 +146,16 @@ mask
:members:

mmdet.testing
--------------
.. automodule::mmdet.testing
----------------
.. automodule:: mmdet.testing
:members:

mmdet.visulization
--------------
.. automodule::mmdet.visulization
mmdet.visualization
--------------------
.. automodule:: mmdet.visualization
:members:

mmdet.utils
--------------
.. automodule::mmdet.utils
.. automodule:: mmdet.utils
:members:
4 changes: 3 additions & 1 deletion requirements/readthedocs.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
mmcv
mmcv>=2.0.0rc1,<2.1.0
mmengine>=0.1.0,<1.0.0
scipy
torch
torchvision

0 comments on commit fbd7edf

Please sign in to comment.