From 9d8e6d1d9bd178b156e21c409738398d9ff7c2da Mon Sep 17 00:00:00 2001
From: Quentin Blampey <quentin.blampey@gmail.com>
Date: Wed, 15 Jan 2025 09:43:23 +0100
Subject: [PATCH 1/2] add autodoc_default_options to docs conf.py (#828)

---
 docs/api/SpatialData.md     |  1 -
 docs/api/data_formats.md    | 18 ------------------
 docs/api/dataloader.md      |  1 -
 docs/api/models.md          | 14 --------------
 docs/api/transformations.md | 14 --------------
 docs/conf.py                |  6 ++++++
 6 files changed, 6 insertions(+), 48 deletions(-)

diff --git a/docs/api/SpatialData.md b/docs/api/SpatialData.md
index cec5b6170..fe70bbe32 100644
--- a/docs/api/SpatialData.md
+++ b/docs/api/SpatialData.md
@@ -4,5 +4,4 @@
 .. currentmodule:: spatialdata
 
 .. autoclass:: SpatialData
-   :members:
 ```
diff --git a/docs/api/data_formats.md b/docs/api/data_formats.md
index 3cf15c1f9..825d2dfdc 100644
--- a/docs/api/data_formats.md
+++ b/docs/api/data_formats.md
@@ -7,30 +7,12 @@ These classes are useful to ensure backward compatibility whenever a major versi
 .. currentmodule:: spatialdata._io.format
 
 .. autoclass:: CurrentRasterFormat
-   :members:
-   :undoc-members:
 .. autoclass:: RasterFormatV01
-   :members:
-   :undoc-members:
 .. autoclass:: CurrentShapesFormat
-   :members:
-   :undoc-members:
 .. autoclass:: ShapesFormatV01
-   :members:
-   :undoc-members:
 .. autoclass:: ShapesFormatV02
-   :members:
-   :undoc-members:
 .. autoclass:: CurrentPointsFormat
-   :members:
-   :undoc-members:
 .. autoclass:: PointsFormatV01
-   :members:
-   :undoc-members:
 .. autoclass:: CurrentTablesFormat
-   :members:
-   :undoc-members:
 .. autoclass:: TablesFormatV01
-   :members:
-   :undoc-members:
 ```
diff --git a/docs/api/dataloader.md b/docs/api/dataloader.md
index d214c19a9..937fc18e8 100644
--- a/docs/api/dataloader.md
+++ b/docs/api/dataloader.md
@@ -4,5 +4,4 @@
 .. currentmodule:: spatialdata.dataloader
 
 .. autoclass:: ImageTilesDataset
-   :members:
 ```
diff --git a/docs/api/models.md b/docs/api/models.md
index 553f64b48..8cee13cba 100644
--- a/docs/api/models.md
+++ b/docs/api/models.md
@@ -6,24 +6,10 @@ The elements (building-blocks) that constitute `SpatialData`.
 .. currentmodule:: spatialdata.models
 
 .. autoclass:: Image2DModel
-   :members:
-   :undoc-members:
 .. autoclass:: Image3DModel
-   :members:
-   :undoc-members:
 .. autoclass:: Labels2DModel
-   :members:
-   :undoc-members:
 .. autoclass:: Labels3DModel
-   :members:
-   :undoc-members:
 .. autoclass:: ShapesModel
-   :members:
-   :undoc-members:
 .. autoclass:: PointsModel
-   :members:
-   :undoc-members:
 .. autoclass:: TableModel
-   :members:
-   :undoc-members:
 ```
diff --git a/docs/api/transformations.md b/docs/api/transformations.md
index 9e4cc3f51..8a150071a 100644
--- a/docs/api/transformations.md
+++ b/docs/api/transformations.md
@@ -6,24 +6,10 @@ The transformations that can be defined between elements and coordinate systems
 .. currentmodule:: spatialdata.transformations
 
 .. autoclass:: BaseTransformation
-   :members:
-   :undoc-members:
 .. autoclass:: Identity
-   :members:
-   :undoc-members:
 .. autoclass:: MapAxis
-   :members:
-   :undoc-members:
 .. autoclass:: Translation
-   :members:
-   :undoc-members:
 .. autoclass:: Scale
-   :members:
-   :undoc-members:
 .. autoclass:: Affine
-   :members:
-   :undoc-members:
 .. autoclass:: Sequence
-   :members:
-   :undoc-members:
 ```
diff --git a/docs/conf.py b/docs/conf.py
index 2c7f2b694..b03bf399d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -59,6 +59,12 @@
     *[p.stem for p in (HERE / "extensions").glob("*.py")],
 ]
 
+autodoc_default_options = {
+    'members': True,
+    'inherited-members': True,
+    'show-inheritance': True,
+}
+
 autosummary_generate = True
 autodoc_process_signature = True
 autodoc_member_order = "groupwise"

From 743535b14c665d00880dcfcc8a9995790f0b17c8 Mon Sep 17 00:00:00 2001
From: "pre-commit-ci[bot]"
 <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Date: Wed, 15 Jan 2025 08:48:03 +0000
Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci
---
 docs/conf.py | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index b03bf399d..6efe4c54a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -60,9 +60,9 @@
 ]
 
 autodoc_default_options = {
-    'members': True,
-    'inherited-members': True,
-    'show-inheritance': True,
+    "members": True,
+    "inherited-members": True,
+    "show-inheritance": True,
 }
 
 autosummary_generate = True