diff --git a/apis/python/src/tiledbsoma/__init__.py b/apis/python/src/tiledbsoma/__init__.py index 5c4ea7b031..4489fd9d73 100644 --- a/apis/python/src/tiledbsoma/__init__.py +++ b/apis/python/src/tiledbsoma/__init__.py @@ -6,7 +6,7 @@ Python package is an implementation of SOMA using the `TileDB Embedded `_ engine. -Provides: +Provides ---------- 1. The ability to store, query, and retrieve larger-than-core datasets, resident in both cloud (object-store) and local (file) systems. @@ -17,7 +17,7 @@ See the `SOMA GitHub repo `_ for more information on the SOMA project. -Using the documentation: +Using the documentation ------------------------- Documentation is also available via the Python builtin ``help`` function. We @@ -26,7 +26,7 @@ >>> import tiledbsoma >>> help(tiledbsoma.DataFrame) -API maturity tags: +API maturity tags ------------------ Classes and functions are annotated with API maturity tags, for example: @@ -49,7 +49,7 @@ If no tag is present, the state is ``experimental``. -Data types: +Data types ------------ The principal persistent types provided by SOMA are: @@ -76,7 +76,7 @@ example, the schema of a :class:`DataFrame` is expressed as an `Arrow Schema `_. -Error handling: +Error handling --------------- Most errors will be signaled with a raised Exception. Of note: @@ -87,9 +87,6 @@ Most errors will raise an appropriate Python error, e.g., ::class:`TypeError` or :class:`ValueError`. - -Classes and functions: ----------------------- """ # ^^ the rest is autogen whether viewed from Python on-line help, Sphinx/readthedocs, etc. It's diff --git a/doc/source/conf.py b/doc/source/conf.py index 5088cf6a4a..816da9cdd0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -39,9 +39,12 @@ "sphinx.ext.doctest", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", + "sphinx.ext.autosummary", "nbsphinx", ] +autosummary_generate = True + # Mapping for linking between RTD subprojects. if readthedocs: intersphinx_mapping = { diff --git a/doc/source/python-api.rst b/doc/source/python-api.rst index 514c7d31e8..3a480a0feb 100644 --- a/doc/source/python-api.rst +++ b/doc/source/python-api.rst @@ -18,17 +18,10 @@ Features: * Enables out-of-core access to data aggregations much larger than single-host main memory * Enables distributed computation over datasets -The tiledbsoma module ---------------------- -.. automodule:: tiledbsoma - :members: - -The tiledbsoma.io module ------------------------- -.. automodule:: tiledbsoma.io - :members: - -The tiledbsoma.logging module ------------------------------ -.. automodule:: tiledbsoma.logging - :members: + +.. toctree:: + :maxdepth: 2 + + python-tiledbsoma + python-tiledbsoma-io + python-tiledbsoma-logging \ No newline at end of file diff --git a/doc/source/python-tiledbsoma-io.rst b/doc/source/python-tiledbsoma-io.rst new file mode 100644 index 0000000000..212ac1749f --- /dev/null +++ b/doc/source/python-tiledbsoma-io.rst @@ -0,0 +1,22 @@ +The tiledbsoma.io module +===================== + +.. currentmodule:: tiledbsoma.io + +.. automodule:: tiledbsoma.io + + +Functions +------- + +.. autosummary:: + :toctree: _autosummary/ + :nosignatures: + + tiledbsoma.io.from_h5ad + tiledbsoma.io.from_anndata + tiledbsoma.io.add_X_layer + tiledbsoma.io.add_matrix_to_collection + tiledbsoma.io.create_from_matrix + tiledbsoma.io.to_h5ad + tiledbsoma.io.to_anndata \ No newline at end of file diff --git a/doc/source/python-tiledbsoma-logging.rst b/doc/source/python-tiledbsoma-logging.rst new file mode 100644 index 0000000000..a00cb948fc --- /dev/null +++ b/doc/source/python-tiledbsoma-logging.rst @@ -0,0 +1,18 @@ +The tiledbsoma.logging module +===================== + +.. currentmodule:: tiledbsoma.logging + +.. automodule:: tiledbsoma.logging + + +Functions +------- + +.. autosummary:: + :toctree: _autosummary/ + :nosignatures: + + tiledbsoma.logging.info + tiledbsoma.logging.debug + tiledbsoma.logging.warning \ No newline at end of file diff --git a/doc/source/python-tiledbsoma.rst b/doc/source/python-tiledbsoma.rst new file mode 100644 index 0000000000..242ecef3e1 --- /dev/null +++ b/doc/source/python-tiledbsoma.rst @@ -0,0 +1,59 @@ +The tiledbsoma module +===================== + +.. currentmodule:: tiledbsoma + +.. automodule:: tiledbsoma + +Classes +------- + +.. autosummary:: + :toctree: _autosummary/ + :nosignatures: + + tiledbsoma.Collection + tiledbsoma.Experiment + tiledbsoma.Measurement + + tiledbsoma.DataFrame + tiledbsoma.SparseNDArray + tiledbsoma.DenseNDArray + + tiledbsoma.ResultOrder + + tiledbsoma.AxisColumnNames + tiledbsoma.AxisQuery + tiledbsoma.ExperimentAxisQuery + + tiledbsoma.SOMATileDBContext + +Exceptions +---------- + +.. autosummary:: + :toctree: _autosummary/ + :nosignatures: + + tiledbsoma.DoesNotExistError + tiledbsoma.SOMAError + +Functions +--------- + +.. autosummary:: + :toctree: _autosummary/ + :nosignatures: + + tiledbsoma.open + + tiledbsoma.show_package_versions + + tiledbsoma.get_implementation + tiledbsoma.get_implementation_version + tiledbsoma.get_storage_engine + + tiledbsoma.tiledbsoma_stats_disable + tiledbsoma.tiledbsoma_stats_dump + tiledbsoma.tiledbsoma_stats_enable + tiledbsoma.tiledbsoma_stats_reset \ No newline at end of file