Skip to content
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.

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

[docs] Fix Sphinx issue with linkless summaries #3284

Merged
merged 4 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions doc/source/python-tiledbsoma-axis.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
tiledbsoma.Axis
===============

.. currentmodule:: tiledbsoma

.. autoclass:: Axis

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~Axis.__init__

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~Axis.name
~Axis.unit

35 changes: 35 additions & 0 deletions doc/source/python-tiledbsoma-axiscolumnnames.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
tiledbsoma.AxisColumnNames
==========================

.. currentmodule:: tiledbsoma

.. autoclass:: AxisColumnNames

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~AxisColumnNames.__init__
~AxisColumnNames.clear
~AxisColumnNames.copy
~AxisColumnNames.fromkeys
~AxisColumnNames.get
~AxisColumnNames.items
~AxisColumnNames.keys
~AxisColumnNames.pop
~AxisColumnNames.popitem
~AxisColumnNames.setdefault
~AxisColumnNames.update
~AxisColumnNames.values

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~AxisColumnNames.obs
~AxisColumnNames.var

24 changes: 24 additions & 0 deletions doc/source/python-tiledbsoma-axisquery.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
tiledbsoma.AxisQuery
====================

.. currentmodule:: tiledbsoma

.. autoclass:: AxisQuery

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~AxisQuery.__init__

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~AxisQuery.value_filter
~AxisQuery.coords

54 changes: 54 additions & 0 deletions doc/source/python-tiledbsoma-collection.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
tiledbsoma.Collection
=====================

.. currentmodule:: tiledbsoma

.. autoclass:: Collection

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~Collection.__init__
~Collection.exists
~Collection.create
~Collection.open
~Collection.reopen
~Collection.close
~Collection.verify_open_for_writing

~Collection.items
~Collection.keys
~Collection.values
~Collection.members
~Collection.get
~Collection.set
~Collection.setdefault
~Collection.update
~Collection.clear
~Collection.pop
~Collection.popitem

~Collection.add_new_collection
~Collection.add_new_dataframe
~Collection.add_new_dense_ndarray
~Collection.add_new_sparse_ndarray

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~Collection.uri
~Collection.closed
~Collection.context
~Collection.metadata

~Collection.mode
~Collection.soma_type
~Collection.tiledb_timestamp
~Collection.tiledb_timestamp_ms

27 changes: 27 additions & 0 deletions doc/source/python-tiledbsoma-coordinatespace.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
tiledbsoma.CoordinateSpace
==========================

.. currentmodule:: tiledbsoma

.. autoclass:: CoordinateSpace

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~CoordinateSpace.__init__
~CoordinateSpace.count
~CoordinateSpace.from_axis_names
~CoordinateSpace.index

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~CoordinateSpace.axes
~CoordinateSpace.axis_names

58 changes: 58 additions & 0 deletions doc/source/python-tiledbsoma-dataframe.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
tiledbsoma.DataFrame
====================

.. currentmodule:: tiledbsoma

.. autoclass:: DataFrame

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~DataFrame.__init__
~DataFrame.exists
~DataFrame.create
~DataFrame.open
~DataFrame.reopen
~DataFrame.close
~DataFrame.read
~DataFrame.write
~DataFrame.verify_open_for_writing

~DataFrame.keys

~DataFrame.tiledbsoma_upgrade_domain
~DataFrame.change_domain
~DataFrame.tiledbsoma_resize_soma_joinid_shape
~DataFrame.tiledbsoma_upgrade_soma_joinid_shape
~DataFrame.non_empty_domain

~DataFrame.config_options_from_schema

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~DataFrame.uri
~DataFrame.soma_type
~DataFrame.schema
~DataFrame.index_column_names

~DataFrame.count
~DataFrame.domain
~DataFrame.maxdomain
~DataFrame.tiledbsoma_has_upgraded_domain

~DataFrame.mode
~DataFrame.closed

~DataFrame.context
~DataFrame.tiledb_timestamp
~DataFrame.tiledb_timestamp_ms

~DataFrame.metadata

53 changes: 53 additions & 0 deletions doc/source/python-tiledbsoma-densendarray.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
tiledbsoma.DenseNDArray
=======================

.. currentmodule:: tiledbsoma

.. autoclass:: DenseNDArray

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~DenseNDArray.__init__
~DenseNDArray.exists
~DenseNDArray.create
~DenseNDArray.open
~DenseNDArray.reopen
~DenseNDArray.close
~DenseNDArray.read
~DenseNDArray.write
~DenseNDArray.verify_open_for_writing

~DenseNDArray.non_empty_domain
~DenseNDArray.resize

~DenseNDArray.config_options_from_schema

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~DenseNDArray.uri
~DenseNDArray.soma_type
~DenseNDArray.schema
~DenseNDArray.is_sparse

~DenseNDArray.ndim
~DenseNDArray.nnz
~DenseNDArray.shape
~DenseNDArray.maxshape
~DenseNDArray.tiledbsoma_has_upgraded_shape

~DenseNDArray.mode
~DenseNDArray.closed

~DenseNDArray.context
~DenseNDArray.tiledb_timestamp
~DenseNDArray.tiledb_timestamp_ms

~DenseNDArray.metadata
59 changes: 59 additions & 0 deletions doc/source/python-tiledbsoma-experiment.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
tiledbsoma.Experiment
=====================

.. currentmodule:: tiledbsoma

.. autoclass:: Experiment

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~Experiment.__init__
~Experiment.exists
~Experiment.create
~Experiment.open
~Experiment.reopen
~Experiment.close
~Experiment.verify_open_for_writing

~Experiment.items
~Experiment.keys
~Experiment.values
~Experiment.members
~Experiment.get
~Experiment.set
~Experiment.update
~Experiment.clear
~Experiment.pop
~Experiment.popitem
~Experiment.setdefault

~Experiment.add_new_collection
~Experiment.add_new_dataframe
~Experiment.add_new_dense_ndarray
~Experiment.add_new_sparse_ndarray

~Experiment.axis_query

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~Experiment.closed
~Experiment.context
~Experiment.metadata
~Experiment.mode
~Experiment.ms
~Experiment.obs
~Experiment.obs_spatial_presence
~Experiment.soma_type
~Experiment.spatial
~Experiment.tiledb_timestamp
~Experiment.tiledb_timestamp_ms
~Experiment.uri

38 changes: 38 additions & 0 deletions doc/source/python-tiledbsoma-experimentaxisquery.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
tiledbsoma.ExperimentAxisQuery
==============================

.. currentmodule:: tiledbsoma

.. autoclass:: ExperimentAxisQuery

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~ExperimentAxisQuery.X
~ExperimentAxisQuery.__init__
~ExperimentAxisQuery.close
~ExperimentAxisQuery.obs
~ExperimentAxisQuery.obs_joinids
~ExperimentAxisQuery.obs_scene_ids
~ExperimentAxisQuery.obsm
~ExperimentAxisQuery.obsp
~ExperimentAxisQuery.to_anndata
~ExperimentAxisQuery.var
~ExperimentAxisQuery.var_joinids
~ExperimentAxisQuery.var_scene_ids
~ExperimentAxisQuery.varm
~ExperimentAxisQuery.varp

.. rubric:: Attributes

.. autosummary::
:toctree: _generated

~ExperimentAxisQuery.indexer
~ExperimentAxisQuery.n_obs
~ExperimentAxisQuery.n_vars

17 changes: 17 additions & 0 deletions doc/source/python-tiledbsoma-intindexer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
tiledbsoma.IntIndexer
=====================

.. currentmodule:: tiledbsoma

.. autoclass:: IntIndexer

.. automethod:: __init__

.. rubric:: Methods

.. autosummary::
:toctree: _generated

~IntIndexer.__init__
~IntIndexer.get_indexer

Loading
Loading