Skip to content

Commit

Permalink
Documenting the index API a bit better.
Browse files Browse the repository at this point in the history
  • Loading branch information
SpacemanPaul committed Dec 13, 2024
1 parent bad0124 commit c8eb6e0
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/api/indexed-data/dataset-writing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ The following "high level" API helps you get new datasets into a form ready to p
in a particular index.

.. currentmodule:: datacube.index.hl
.. autocloss:: Doc2Dataset
.. autoclass:: Doc2Dataset
:members:
29 changes: 18 additions & 11 deletions docs/api/indexed-data/index-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,6 @@ Types
BatchStatus
DatasetTuple

Main API resources
------------------

.. autosummary::

AbstractIndex
AbstractUserResource
AbstractProductResource
AbstractDatasetResource
AbstractLineageResource

Other Driver Requirements
-------------------------

Expand All @@ -33,3 +22,21 @@ Other Driver Requirements
default_metadata_type_docs
AbstractIndexDriver
AbstractTransaction

Main API resources
------------------

.. autoclass:: AbstractIndex
:members:

..autoclass:: AbstractUserResource
:members:

..autoclass:: AbstractProductResource
:members:

..autoclass:: AbstractDatasetResource
:members:

..autoclass:: AbstractLineageResource
:members:

0 comments on commit c8eb6e0

Please sign in to comment.