[python] Add spatial transforms to readthedocs (#3634) (#3635)

Co-authored-by: John Kerl <[email protected]>
single-cell-data · Jan 28, 2025 · a20eb52 · a20eb52
1 parent 4eb5cf8
commit a20eb52
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 0 deletions.
diff --git a/doc/source/python-tiledbsoma-affine-transform.rst b/doc/source/python-tiledbsoma-affine-transform.rst
@@ -0,0 +1,27 @@
+tiledbsoma.AffineTransform
+==========================
+
+.. currentmodule:: tiledbsoma
+
+.. autoclass:: AffineTransform
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~AffineTransform.__init__
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~AffineTransform.augmented_matrix
+      ~AffineTransform.input_axes
+      ~AffineTransform.inverse_transform
+      ~AffineTransform.mro
+      ~AffineTransform.output_axes
+      ~AffineTransform.register
diff --git a/doc/source/python-tiledbsoma-identity-transform.rst b/doc/source/python-tiledbsoma-identity-transform.rst
@@ -0,0 +1,29 @@
+tiledbsoma.IdentityTransform
+============================
+
+.. currentmodule:: tiledbsoma
+
+.. autoclass:: IdentityTransform
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~IdentityTransform.__init__
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~IdentityTransform.augmented_matrix
+      ~IdentityTransform.input_axes
+      ~IdentityTransform.inverse_transform
+      ~IdentityTransform.mro
+      ~IdentityTransform.output_axes
+      ~IdentityTransform.register
+      ~IdentityTransform.scale
+      ~IdentityTransform.scale_factors
diff --git a/doc/source/python-tiledbsoma-scale-transform.rst b/doc/source/python-tiledbsoma-scale-transform.rst
@@ -0,0 +1,28 @@
+tiledbsoma.ScaleTransform
+=========================
+
+.. currentmodule:: tiledbsoma
+
+.. autoclass:: ScaleTransform
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~ScaleTransform.__init__
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~ScaleTransform.augmented_matrix
+      ~ScaleTransform.input_axes
+      ~ScaleTransform.inverse_transform
+      ~ScaleTransform.mro
+      ~ScaleTransform.output_axes
+      ~ScaleTransform.register
+      ~ScaleTransform.scale_factors
diff --git a/doc/source/python-tiledbsoma-uniform-scale-transform.rst b/doc/source/python-tiledbsoma-uniform-scale-transform.rst
@@ -0,0 +1,29 @@
+tiledbsoma.UniformScaleTransform
+================================
+
+.. currentmodule:: tiledbsoma
+
+.. autoclass:: UniformScaleTransform
+
+   .. automethod:: __init__
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~UniformScaleTransform.__init__
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+      :toctree: _generated
+
+      ~UniformScaleTransform.augmented_matrix
+      ~UniformScaleTransform.input_axes
+      ~UniformScaleTransform.inverse_transform
+      ~UniformScaleTransform.mro
+      ~UniformScaleTransform.output_axes
+      ~UniformScaleTransform.register
+      ~UniformScaleTransform.scale
+      ~UniformScaleTransform.scale_factors
diff --git a/doc/source/python-tiledbsoma.rst b/doc/source/python-tiledbsoma.rst
@@ -25,6 +25,10 @@ Classes
     python-tiledbsoma-multiscaleimage
     python-tiledbsoma-pointclouddataframe
     python-tiledbsoma-scene
+    python-tiledbsoma-affine-transform
+    python-tiledbsoma-identity-transform
+    python-tiledbsoma-scale-transform
+    python-tiledbsoma-uniform-scale-transform
 
     python-tiledbsoma-resultorder