Skip to content

Add autodoc_default_options to inherit docstrings #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LucaMarconato merged 2 commits into from
Jan 15, 2025
Merged

Add autodoc_default_options to inherit docstrings #830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d8e6d1
add autodoc_default_options to docs conf.py (#828)
quentinblampey Jan 15, 2025
743535b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/api/SpatialData.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
.. currentmodule:: spatialdata

.. autoclass:: SpatialData
:members:
```
18 changes: 0 additions & 18 deletions docs/api/data_formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
1 change: 0 additions & 1 deletion docs/api/dataloader.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@
.. currentmodule:: spatialdata.dataloader

.. autoclass:: ImageTilesDataset
:members:
```
14 changes: 0 additions & 14 deletions docs/api/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
14 changes: 0 additions & 14 deletions docs/api/transformations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
```
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading