Update docs

TomographicImaging · Aug 22, 2024 · 56f8979 · 56f8979
1 parent edb7953
commit 56f8979
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 25 deletions.
diff --git a/Wrappers/Python/cil/framework/labels.py b/Wrappers/Python/cil/framework/labels.py
@@ -121,13 +121,6 @@ class ImageDimension(_DimensionBase, StrEnum):
     """
     Available dimension labels for image data.
 
-    Attributes
-    ----------
-    CHANNEL
-    VERTICAL
-    HORIZONTAL_X
-    HORIZONTAL_Y
-
     Examples
     --------
     >>> data.reorder([ImageDimension.HORIZONTAL_X, ImageDimension.VERTICAL])
@@ -153,13 +146,6 @@ class AcquisitionDimension(_DimensionBase, StrEnum):
     """
     Available dimension labels for acquisition data.
 
-    Attributes
-    ----------
-    CHANNEL
-    ANGLE
-    VERTICAL
-    HORIZONTAL
-
     Examples
     --------
     >>> data.reorder([AcquisitionDimension.CHANNEL,
@@ -188,8 +174,10 @@ class FillType(StrEnum):
 
     Attributes
     ----------
-    RANDOM: Fill with random values.
-    RANDOM_INT: Fill with random integers.
+    RANDOM: 
+        Fill with random values.
+    RANDOM_INT: 
+        Fill with random integers.
 
     Examples
     --------
@@ -203,11 +191,6 @@ class FillType(StrEnum):
 class AngleUnit(StrEnum):
     """
     Available units for angles.
-    
-    Attributes
-    ----------
-    DEGREE
-    RADIAN
 
     Examples
     --------
@@ -242,10 +225,14 @@ class AcquisitionType(Flag):
 
     Attributes
     ----------
-    PARALLEL: Parallel beam.
-    CONE: Cone beam.
-    DIM2: 2D acquisition.
-    DIM3: 3D acquisition.
+    PARALLEL: 
+        Parallel beam.
+    CONE: 
+        Cone beam.
+    DIM2: 
+        2D acquisition.
+    DIM3: 
+        3D acquisition.
     """
     PARALLEL = auto()
     CONE = auto()

diff --git a/docs/source/framework.rst b/docs/source/framework.rst
@@ -238,15 +238,18 @@ Classes which define the accepted labels
 
 .. autoclass:: cil.framework.labels.ImageDimension
    :members:
+   :undoc-members:
 
 .. autoclass:: cil.framework.labels.AcquisitionDimension
    :members:
+   :undoc-members:
 
 .. autoclass:: cil.framework.labels.FillType
    :members:
 
 .. autoclass:: cil.framework.labels.AngleUnit
    :members:
+   :undoc-members:
 
 .. autoclass:: cil.framework.labels.AcquisitionType
    :members: