diff --git a/docs/api/core-classes/lineage-tree.rst b/docs/api/core-classes/lineage-tree.rst new file mode 100644 index 0000000000..fad6b4b26d --- /dev/null +++ b/docs/api/core-classes/lineage-tree.rst @@ -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: diff --git a/docs/api/core-classes/metadataType.rst b/docs/api/core-classes/metadataType.rst index 74c88b599d..a7b0061ec7 100644 --- a/docs/api/core-classes/metadataType.rst +++ b/docs/api/core-classes/metadataType.rst @@ -6,5 +6,4 @@ Metadata Type .. currentmodule:: datacube .. autoclass:: datacube.model.MetadataType - :members: diff --git a/docs/api/core-classes/product.rst b/docs/api/core-classes/product.rst index 34f61b5531..54572864d1 100644 --- a/docs/api/core-classes/product.rst +++ b/docs/api/core-classes/product.rst @@ -1,9 +1,8 @@ -============ -Dataset Type -============ +======= +Product +======= -.. currentmodule:: datacube - -.. autoclass:: datacube.model.Product +.. currentmodule:: datacube.model +.. autoclass:: Product :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index f31863bd22..57bb62ec7b 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -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 @@ -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:: diff --git a/docs/api/indexed-data/dataset-writing.rst b/docs/api/indexed-data/dataset-writing.rst index 6317c4dacc..b50841a3e5 100644 --- a/docs/api/indexed-data/dataset-writing.rst +++ b/docs/api/indexed-data/dataset-writing.rst @@ -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 @@ -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: diff --git a/docs/api/indexed-data/index-api.rst b/docs/api/indexed-data/index-api.rst new file mode 100644 index 0000000000..4f55adb59b --- /dev/null +++ b/docs/api/indexed-data/index-api.rst @@ -0,0 +1,10 @@ +========= +Index API +========= + +This is the API implemented by an ODC index driver + +.. autosummary:: + :recursive: + + datacube.index.abstract diff --git a/docs/api/indexed-data/masking.rst b/docs/api/indexed-data/masking.rst index 9870c139b6..54a49a765e 100644 --- a/docs/api/indexed-data/masking.rst +++ b/docs/api/indexed-data/masking.rst @@ -1,8 +1,6 @@ Masking ======= -.. py:module:: datacube.utils.masking - .. _bit-masking: Bit Masking @@ -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 ---------------------------------- @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~