[Fix] pypi bug (#9)

openxrlab · Oct 1, 2023 · 46b9d52 · 46b9d52
1 parent 53c6c23
commit 46b9d52
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 4 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -22,7 +22,7 @@ license = { text = 'Apache License 2.0' }
 classifiers = [
     "Operating System :: Microsoft :: Windows",
     "Operating System :: Unix",
-    "Operating System :: MacOS :: MacOS",
+    "Operating System :: MacOS",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",

diff --git a/xrfeitoria/data_structure/models.py b/xrfeitoria/data_structure/models.py
@@ -21,6 +21,46 @@
 class RenderPass(BaseModel):
     """Render pass model contains render layer and image format.
 
+    Supported render layer and image format:
+
+        .. tabs::
+            .. tab:: RenderLayerBlender
+
+                :class:`~xrfeitoria.data_structure.constants.RenderOutputEnumBlender`:
+
+                    - img
+                    - mask
+                    - depth
+                    - flow
+                    - normal
+                    - diffuse
+                    - denoising_depth
+
+            .. tab:: RenderLayerUnreal
+
+                :class:`~xrfeitoria.data_structure.constants.RenderOutputEnumUnreal`:
+
+                    - img
+                    - mask
+                    - depth
+                    - flow
+                    - normal
+                    - diffuse
+                    - metallic
+                    - roughness
+                    - specular
+                    - tangent
+                    - basecolor
+
+            .. tab:: ImageFormat
+
+                :class:`~xrfeitoria.data_structure.constants.ImageFileFormatEnum`:
+
+                    - png
+                    - bmp
+                    - jpg
+                    - exr
+
     Used in:
         - :class:`~xrfeitoria.data_structure.models.RenderJobBlender`
         - :class:`~xrfeitoria.data_structure.models.RenderJobUnreal`
@@ -109,10 +149,10 @@ def __init__(
         format.
 
         Args:
-            render_layer (Union[RenderLayerEnumBlender, RenderLayerEnumUnreal, str]):
+            render_layer (Union[RenderOutputEnumBlender, RenderOutputEnumUnreal, str]):
                 Render layer of Unreal or Blender. Should be one of the following enum, or the string of it:
-                    `RenderLayerEnumBlender`: `img`, `mask`, `depth`, `denoising_depth`, `flow`, `normal`, `diffuse` \n
-                    `RenderLayerEnumUnreal`: `img`, `mask`, `depth`, `flow`, `normal`, `diffuse`,
+                    `RenderOutputEnumBlender`: `img`, `mask`, `depth`, `denoising_depth`, `flow`, `normal`, `diffuse` \n
+                    `RenderOutputEnumUnreal`: `img`, `mask`, `depth`, `flow`, `normal`, `diffuse`,
                     `metallic`, `roughness`, `specular`, `tangent`, `basecolor`
             image_format (Union[ImageFileFormatEnum, str]):
                 Image format of Unreal or Blender.  Should be element of the enum, or the string of it: