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..6efe4c54a 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"