add webcam_api.rst

open-mmlab · Nov 11, 2022 · 4455c25 · 4455c25
1 parent 47da338
commit 4455c25
Show file tree

Hide file tree

Showing 5 changed files with 234 additions and 116 deletions.
diff --git a/docs/en/api.rst b/docs/en/api.rst
@@ -133,115 +133,4 @@ hooks
 .. automodule:: mmpose.engine.hooks
     :members:
 
-mmpose.apis.webcam
---------------------
-.. contents:: MMPose Webcam API: Tools to build simple interactive webcam applications and demos
-    :depth: 2
-    :local:
-    :backlinks: top
-
-Executor
-^^^^^^^^^^^^^^^^^^^^
-.. currentmodule:: mmpose.apis.webcam
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-
-    WebcamExecutor
-
-Nodes
-^^^^^^^^^^^^^^^^^^^^
-.. currentmodule:: mmpose.apis.webcam.nodes
-
-Base Nodes
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-    :template: webcam_node_class.rst
-
-    Node
-    BaseVisualizerNode
-
-Model Nodes
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-    :template: webcam_node_class.rst
-
-    DetectorNode
-    TopdownPoseEstimatorNode
-
-Visualizer Nodes
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-    :template: webcam_node_class.rst
-
-    ObjectVisualizerNode
-    NoticeBoardNode
-    SunglassesEffectNode
-    BigeyeEffectNode
-
-Helper Nodes
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-    :template: webcam_node_class.rst
-
-    ObjectAssignerNode
-    MonitorNode
-    RecorderNode
-
-Utils
-^^^^^^^^^^^^^^^^^^^^
-.. currentmodule:: mmpose.apis.webcam.utils
-
-Buffer and Message
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-
-    BufferManager
-    Message
-    FrameMessage
-    VideoEndingMessage
-
-Pose
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-
-    get_eye_keypoint_ids
-    get_face_keypoint_ids
-    get_hand_keypoint_ids
-    get_mouth_keypoint_ids
-    get_wrist_keypoint_ids
-
-Event
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-
-    EventManager
-
-Misc
-""""""""""""""""""""
-.. autosummary::
-    :toctree: generated
-    :nosignatures:
-
-    copy_and_paste
-    screen_matting
-    expand_and_clamp
-    limit_max_fps
-    is_image_file
-    get_cached_file_path
-    load_image_from_disk_or_url
-    get_config_path
+.. include:: webcam_api.rst
diff --git a/docs/en/webcam_api.rst b/docs/en/webcam_api.rst
@@ -0,0 +1,112 @@
+mmpose.apis.webcam
+--------------------
+.. contents:: MMPose Webcam API: Tools to build simple interactive webcam applications and demos
+    :depth: 2
+    :local:
+    :backlinks: top
+
+Executor
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    WebcamExecutor
+
+Nodes
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.nodes
+
+Base Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    Node
+    BaseVisualizerNode
+
+Model Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    DetectorNode
+    TopdownPoseEstimatorNode
+
+Visualizer Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectVisualizerNode
+    NoticeBoardNode
+    SunglassesEffectNode
+    BigeyeEffectNode
+
+Helper Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectAssignerNode
+    MonitorNode
+    RecorderNode
+
+Utils
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.utils
+
+Buffer and Message
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    BufferManager
+    Message
+    FrameMessage
+    VideoEndingMessage
+
+Pose
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    get_eye_keypoint_ids
+    get_face_keypoint_ids
+    get_hand_keypoint_ids
+    get_mouth_keypoint_ids
+    get_wrist_keypoint_ids
+
+Event
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    EventManager
+
+Misc
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    copy_and_paste
+    screen_matting
+    expand_and_clamp
+    limit_max_fps
+    is_image_file
+    get_cached_file_path
+    load_image_from_disk_or_url
+    get_config_path
diff --git a/docs/zh_cn/_static/css/readthedocs.css b/docs/zh_cn/_static/css/readthedocs.css
@@ -4,3 +4,7 @@
     height: 50px;
     width: 120px;
 }
+
+table.autosummary td {
+    width: 35%
+}
diff --git a/docs/zh_cn/api.rst b/docs/zh_cn/api.rst
@@ -3,14 +3,11 @@ mmpose.apis
 .. automodule:: mmpose.apis
     :members:
 
-
 mmpose.codecs
 -------------
-
 .. automodule:: mmpose.codecs
     :members:
 
-
 mmpose.models
 ---------------
 backbones
@@ -131,5 +128,9 @@ mmpose.visualization
 
 mmpose.engine
 ---------------
-.. automodule:: mmpose.engine
+hooks
+^^^^^^^^^^^
+.. automodule:: mmpose.engine.hooks
     :members:
+
+.. include:: webcam_api.rst
diff --git a/docs/zh_cn/webcam_api.rst b/docs/zh_cn/webcam_api.rst
@@ -0,0 +1,112 @@
+mmpose.apis.webcam
+--------------------
+.. contents:: MMPose Webcam API: Tools to build simple interactive webcam applications and demos
+    :depth: 2
+    :local:
+    :backlinks: top
+
+Executor
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    WebcamExecutor
+
+Nodes
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.nodes
+
+Base Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    Node
+    BaseVisualizerNode
+
+Model Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    DetectorNode
+    TopdownPoseEstimatorNode
+
+Visualizer Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectVisualizerNode
+    NoticeBoardNode
+    SunglassesEffectNode
+    BigeyeEffectNode
+
+Helper Nodes
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+    :template: webcam_node_class.rst
+
+    ObjectAssignerNode
+    MonitorNode
+    RecorderNode
+
+Utils
+^^^^^^^^^^^^^^^^^^^^
+.. currentmodule:: mmpose.apis.webcam.utils
+
+Buffer and Message
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    BufferManager
+    Message
+    FrameMessage
+    VideoEndingMessage
+
+Pose
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    get_eye_keypoint_ids
+    get_face_keypoint_ids
+    get_hand_keypoint_ids
+    get_mouth_keypoint_ids
+    get_wrist_keypoint_ids
+
+Event
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    EventManager
+
+Misc
+""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :nosignatures:
+
+    copy_and_paste
+    screen_matting
+    expand_and_clamp
+    limit_max_fps
+    is_image_file
+    get_cached_file_path
+    load_image_from_disk_or_url
+    get_config_path