[docs][python] Add autosummary #1392
Conversation
| @@ -6,7 +6,7 @@ | |||
| Python package is an implementation of SOMA using the | |||
| `TileDB Embedded <https://github.com/TileDB-Inc/TileDB>`_ engine. | |||
|
|
|||
| Provides: | |||
| Provides | |||
There was a problem hiding this comment.
Colons should be removed as these end up into toctree entities.
| :members: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 |
There was a problem hiding this comment.
Can be set to 1 if we don't want this toctree to include the subsections.
Codecov ReportPatch coverage has no change and project coverage change:
❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more. Additional details and impacted files@@ Coverage Diff @@
## main #1392 +/- ##
===========================================
+ Coverage 65.36% 91.08% +25.72%
===========================================
Files 96 30 -66
Lines 7720 2400 -5320
===========================================
- Hits 5046 2186 -2860
+ Misses 2674 214 -2460
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
doc/source/python-tiledbsoma-io.rst
Outdated
| tiledbsoma.io.add_X_layer | ||
| tiledbsoma.io.add_matrix_to_collection | ||
| tiledbsoma.io.create_from_matrix | ||
| tiledbsoma.io.from_anndata | ||
| tiledbsoma.io.from_h5ad | ||
| tiledbsoma.io.to_anndata | ||
| tiledbsoma.io.to_h5ad |
Co-authored-by: John Kerl <[email protected]>
Co-authored-by: John Kerl <[email protected]>
Co-authored-by: John Kerl <[email protected]>
Co-authored-by: John Kerl <[email protected]>
Issue and/or context:
Fixes #1326
Changes:
autosummaryto the docs. This creates auto-generated pages for each doc entry (functions, classes etc) and groups them using a hierarchical toctree that shows up in the sidebarNotes for Reviewer: