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

Cleanup Api docs #1688

Draft
wants to merge 10 commits into
base: develop-1.9
Choose a base branch
from
17 changes: 17 additions & 0 deletions docs/api/core-classes/lineage-tree.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
==========
LinageTree
==========

The ``LineageTree`` class is used by the Lineage API for describing lineage trees of datasets.

..note:
Only the ``postgis`` index driver supports the Lineage API.


.. currentmodule:: datacube.model

.. autoclass:: LineageDirection
:members:

.. autoclass:: LineageTree
:members:
11 changes: 5 additions & 6 deletions docs/api/core-classes/product.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
============
Dataset Type
============
=======
Product
=======

.. currentmodule:: datacube

.. autoclass:: datacube.model.Product
.. currentmodule:: datacube.model

.. autoclass:: Product
:members:
2 changes: 2 additions & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ The following pages provide a full API reference for the ``datacube`` python lib
core-classes/geometry
core-classes/measurement
core-classes/metadataType
core-classes/lineage-tree
core-classes/range
core-classes/query

Expand All @@ -35,6 +36,7 @@ The following pages provide a full API reference for the ``datacube`` python lib

indexed-data/dataset-writing
indexed-data/product-writing
indexed-data/index-api


.. toctree::
Expand Down
8 changes: 8 additions & 0 deletions docs/api/indexed-data/dataset-writing.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
===============
Dataset Writing
===============

When connected to an ODC Database, these methods are available for adding, updating and archiving datasets:

.. code-block:: bash
Expand All @@ -23,3 +24,10 @@ When connected to an ODC Database, these methods are available for adding, updat
restore
restore_location
update

The following "high level" API helps you get new datasets into a form ready to pass to the above methods
in a particular index.

.. currentmodule:: datacube.index.hl
.. autoclass:: Doc2Dataset
:members:
32 changes: 32 additions & 0 deletions docs/api/indexed-data/index-api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
=========
Index API
=========

This is the API implemented by an ODC index driver

.. currentmodule:: datacube.index.abstract

Types
-----

.. autosummary::

BatchStatus
DatasetTuple

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

.. autosummary::

default_metadata_type_docs
AbstractIndexDriver
AbstractTransaction

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

.. currentmodule:: datacube.index.abstract

.. autoclass:: AbstractIndex
:members:
8 changes: 3 additions & 5 deletions docs/api/indexed-data/masking.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Masking
=======

.. py:module:: datacube.utils.masking

.. _bit-masking:

Bit Masking
Expand All @@ -13,7 +11,7 @@ Masking No Data Values

.. currentmodule:: datacube.utils.masking

.. automethod:: mask_invalid_data
.. autofunction:: mask_invalid_data

Masking with Bit-Flag Measurements
----------------------------------
Expand All @@ -40,9 +38,9 @@ Open Data Cube provides a way of describing the meanings that can be encoded
in variables, which can then be used to give a readable method when using that
variable.

.. automethod:: describe_variable_flags
.. autofunction:: describe_variable_flags

.. automethod:: make_mask
.. autofunction:: make_mask

How to Define Meanings on Measurements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading