WIP: add new backend api documentation (#4810)

* documentation first draft

* documentation update

* documentation update

* update documentation

* update backend documentation

* incompletre draft: update Backend Documentation

* fix

* fix syle

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: keewis <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* Update doc/internals.rst

Co-authored-by: keewis <[email protected]>

* Update doc/internals.rst

Co-authored-by: keewis <[email protected]>

* Update doc/internals.rst

Co-authored-by: Mathias Hauser <[email protected]>

* update section lazy laoding

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: Deepak Cherian <[email protected]>

* Update doc/internals.rst

Co-authored-by: keewis <[email protected]>

* update internals.rst backend

* add lazy loading documentation

* update example on indexing type

* style

* fix

* modify backend indexing doc

* fix

* removed LazilyVectorizedIndexedArray from backend doc

* small fix in doc

* small fixes in backend doc

* removed exmple vectorized indexing

* update documentation

* update documentation

* isort

* rename store_spec in filename_or_obj in guess_can_open

* small update in backend documentation

* small update in backend documentation

* Update doc/internals.rst

Co-authored-by: Stephan Hoyer <[email protected]>

* Update doc/internals.rst

Co-authored-by: Stephan Hoyer <[email protected]>

* fix backend documentation

* replace LazilyOuterIndexedArray with LazilyIndexedArray

* Update doc/internals.rst

Co-authored-by: Julia Dark <[email protected]>

* Update doc/internals.rst

Co-authored-by: Julia Dark <[email protected]>

* Fix broken doc merge

Co-authored-by: Deepak Cherian <[email protected]>
Co-authored-by: Mathias Hauser <[email protected]>
Co-authored-by: keewis <[email protected]>
Co-authored-by: Stephan Hoyer <[email protected]>
Co-authored-by: Julia Dark <[email protected]>
Co-authored-by: Alessandro Amici <[email protected]>

Author: 7 people

doc/api-hidden.rst

@@ -811,3 +811,28 @@
    backends.DummyFileManager.acquire
    backends.DummyFileManager.acquire_context
    backends.DummyFileManager.close
+
+   backends.common.BackendArray
+   backends.common.BackendEntrypoint
+   backends.common.BackendEntrypoint.guess_can_open
+   backends.common.BackendEntrypoint.open_dataset
+
+   core.indexing.IndexingSupport
+   core.indexing.explicit_indexing_adapter
+   core.indexing.BasicIndexer
+   core.indexing.OuterIndexer
+   core.indexing.VectorizedIndexer
+   core.indexing.LazilyIndexedArray
+   core.indexing.LazilyVectorizedIndexedArray
+
+   conventions.decode_cf_variables
+
+   coding.variables.UnsignedIntegerCoder
+   coding.variables.CFMaskCoder
+   coding.variables.CFScaleOffsetCoder
+
+   coding.strings.CharacterArrayCoder
+   coding.strings.EncodedStringCoder
+
+   coding.times.CFTimedeltaCoder
+   coding.times.CFDatetimeCoder