diff --git a/docs/_extension/docstring.py b/docs/_extension/docstring.py index 56dd2431..16b6baf0 100644 --- a/docs/_extension/docstring.py +++ b/docs/_extension/docstring.py @@ -1,12 +1,16 @@ """A docstring role to read the docstring from a Python method.""" from __future__ import annotations +import inspect +from functools import reduce + +import ee from docutils import nodes from sphinx.application import Sphinx from sphinx.util import logging from sphinx.util.docutils import SphinxRole -import geetools +import geetools # noqa: F401 logger = logging.getLogger(__name__) @@ -16,11 +20,33 @@ class DocstringRole(SphinxRole): def run(self) -> tuple[list[nodes.Node], list[str]]: """Setup the role in the builder context.""" + # retrieve the environment from the node members + env = self.inliner.document.settings.env + builder = env.app.builder + current_doc = self.env.docname + + # extract the members we try to reach from the ee lib members = self.text.split(".")[1:] - o = geetools - [o := getattr(o, m) for m in members] - return [nodes.Text(o.__doc__.splitlines()[0])], [] + # reach the final object using getattr. It will allow us to access the complete information + # of the object (docstring, qualname, name, source module) + try: + o = reduce(getattr, members, ee) + modules = inspect.getmodule(o).__name__.split(".") + except Exception as e: + logger.warning(f"Failed to retrieve {members}: {e}") + return [nodes.Text(f"{self.text} not found")], [] + + # create the docstring node + docstring = nodes.Text(f": {o.__doc__.splitlines()[0]}") + + # create a complete link to the object using the url and the name of the object + target_doc = f"autoapi/{'/'.join(modules)}/{o.__qualname__}" + refuri = builder.get_relative_uri(current_doc, target_doc) + inline_node = nodes.literal(self.text, self.text, classes=["py", "py-meth"]) + link = nodes.reference("", "", inline_node, internal=True, refuri=refuri) + + return [link, docstring], [] def setup(app: Sphinx) -> dict[str, object]: diff --git a/docs/conf.py b/docs/conf.py index 90b18267..33a70335 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,6 +116,7 @@ "special-members", ] autoapi_own_page_level = "method" +autoapi_keep_files = False # -- Options for intersphinx output -------------------------------------------- intersphinx_mapping = {} diff --git a/docs/setup/layout.rst b/docs/setup/layout.rst index 38587ce1..b4209bf7 100644 --- a/docs/setup/layout.rst +++ b/docs/setup/layout.rst @@ -22,21 +22,21 @@ ee.Array constructor ########### +- :docstring:`ee.Array.geetools.full` -- :py:meth:`ee.Array.geetools.full `: Create an array with the given dimensions, initialized to the given value. **Manually loaded** data manipulation ################# -- :py:meth:`ee.Array.geetools.set `: Set the value of a cell in an array. **Manually be loaded** +- :docstring:`ee.Array.geetools.set` ee.Authenticate ^^^^^^^^^^^^^^^ -- :py:meth:`ee.Authenticate.geetools.new_user `: :docstring:`geetools.AuthenticateAccessor.new_user` -- :py:meth:`ee.Authenticate.geetools.delete_user `: :docstring:`geetools.AuthenticateAccessor.delete_user` -- :py:meth:`ee.Authenticate.geetools.list_user `: :docstring:`geetools.AuthenticateAccessor.list_user` -- :py:meth:`ee.Authenticate.geetools.rename_user `: :docstring:`geetools.AuthenticateAccessor.rename_user` +- :docstring:`ee.Authenticate.geetools.new_user` +- :docstring:`ee.Authenticate.geetools.delete_user` +- :docstring:`ee.Authenticate.geetools.list_user` +- :docstring:`ee.Authenticate.geetools.rename_user` ee.ComputedObject @@ -48,13 +48,13 @@ That's also the only Object where the methods are directly added as members with Types management ################ -- :py:meth:`ee.ComputedObject.isInstance `: :docstring:`geetools.ComputedObject.isInstance` +- :docstring:`ee.ComputedObject.isInstance` save json representations ######################### -- :py:meth:`ee.ComputedObject.save `: :docstring:`geetools.ComputedObject.save` -- :py:meth:`ee.ComputedObject.open `: :docstring:`geetools.ComputedObject.open` +- :docstring:`ee.ComputedObject.save` +- :docstring:`ee.ComputedObject.open` ee.Date ^^^^^^^ @@ -62,14 +62,14 @@ ee.Date Constructors ############ -- :py:meth:`ee.Date.geetools.fromEpoch `: :docstring:`geetools.DateAccessor.fromEpoch` -- :py:meth:`ee.Date.geetools.fromDOY `: :docstring:`geetools.DateAccessor.fromDOY` +- :docstring:`ee.Date.geetools.fromEpoch` +- :docstring:`ee.Date.geetools.fromDOY` Extra operations ################ -- :py:meth:`ee.Date.geetools.getUnitSinceEpoch `: :docstring:`geetools.DateAccessor.getUnitSinceEpoch` -- :py:meth:`ee.Date.geetools.isLeap `: :docstring:`geetools.DateAccessor.isLeap` +- :docstring:`ee.Date.geetools.getUnitSinceEpoch` +- :docstring:`ee.Date.geetools.isLeap` Exportation ########### @@ -78,12 +78,12 @@ Exportation As the snake case suggests, this method is client side. -- :py:meth:`ee.Date.geetools.to_datetime `: :docstring:`geetools.DateAccessor.to_datetime` +- :docstring:`ee.Date.geetools.to_datetime` helper ###### -- :py:meth:`ee.Date.geetools.check_unit `: :docstring:`geetools.DateAccessor.check_unit` +- :docstring:`ee.Date.geetools.check_unit` ee.DateRange ^^^^^^^^^^^^ @@ -91,13 +91,13 @@ ee.DateRange Extra operations ################ -- :py:meth:`ee.DateRange.geetools.split `: Convert a ``ee.DateRange`` to a list of ``ee.DateRange``.` +- :docstring:`ee.DateRange.geetools.split` Helper ###### -- :py:meth:`ee.DateRange.geetools.check_unit `: Check if the unit is valid. -- :py:meth:`ee.DateRange.geetools.unitMillis `: Get the milliseconds of a unit. +- :docstring:`ee.DateRange.geetools.check_unit` +- :docstring:`ee.DateRange.geetools.unitMillis` ee.Dictionary ^^^^^^^^^^^^^ @@ -105,19 +105,19 @@ ee.Dictionary Constructors ############ -- :py:meth:`ee.Dictionary.geetools.fromPairs `: :docstring:`geetools.DictionaryAccessor.fromPairs` +- :docstring:`ee.Dictionary.geetools.fromPairs` Extra operations ################ -- :py:meth:`ee.Dictionary.geetools.sort `: :docstring:`geetools.DictionaryAccessor.sort` -- :py:meth:`ee.Dictionary.geetools.getMany `: :docstring:`geetools.DictionaryAccessor.getMany` +- :docstring:`ee.Dictionary.geetools.sort` +- :docstring:`ee.Dictionary.geetools.getMany` ee.Feature ^^^^^^^^^^ -- :py:meth:`ee.Feature.geetools.toFeatureCollection `: :docstring:`geetools.FeatureAccessor.toFeatureCollection` -- :py:meth:`ee.Feature.geetools.removeProperties `: :docstring:`geetools.FeatureAccessor.removeProperties` +- :docstring:`ee.Feature.geetools.toFeatureCollection` +- :docstring:`ee.Feature.geetools.removeProperties` ee.FeatureCollection ^^^^^^^^^^^^^^^^^^^^ @@ -125,38 +125,38 @@ ee.FeatureCollection Properties management ##################### -- :py:meth:`ee.FeatureCollection.geetools.addId `: :docstring:`geetools.FeatureCollectionAccessor.addId` +- :docstring:`ee.FeatureCollection.geetools.addId` Geometry management ################### -- :py:meth:`ee.FeatureCollection.geetools.mergeGeometries `: :docstring:`geetools.FeatureCollectionAccessor.mergeGeometries` -- :py:meth:`ee.FeatureCollection.geetools.toPolygons `: :docstring:`geetools.FeatureCollectionAccessor.toPolygons` +- :docstring:`ee.FeatureCollection.geetools.mergeGeometries` +- :docstring:`ee.FeatureCollection.geetools.toPolygons` Converter ######### -- :py:meth:`ee.FeatureCollection.geetools.toImage `: :docstring:`geetools.FeatureCollectionAccessor.toImage` -- :py:meth:`ee.FeatureCollection.geetools.byFeatures `: :docstring:`geetools.FeatureCollectionAccessor.byFeatures` -- :py:meth:`ee.FeatureCollection.geetools.byProperties `: :docstring:`geetools.FeatureCollectionAccessor.byProperties` +- :docstring:`ee.FeatureCollection.geetools.toImage` +- :docstring:`ee.FeatureCollection.geetools.byFeatures` +- :docstring:`ee.FeatureCollection.geetools.byProperties` Plotting ######## -- :py:meth:`ee.FeatureCollection.geetools.plot_by_features `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_features` -- :py:meth:`ee.FeatureCollection.geetools.plot_by_properties `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_properties` -- :py:meth:`ee.FeatureCollection.geetools.plot_hist `: :docstring:`geetools.FeatureCollectionAccessor.plot_hist` +- :docstring:`ee.FeatureCollection.geetools.plot_by_features` +- :docstring:`ee.FeatureCollection.geetools.plot_by_properties` +- :docstring:`ee.FeatureCollection.geetools.plot_hist` ee.Filter ^^^^^^^^^ -- :py:meth:`ee.Filter.geetools.dateRange `: :docstring:`geetools.FilterAccessor.dateRange` +- :docstring:`ee.Filter.geetools.dateRange` ee.Geometry ^^^^^^^^^^^ -- :py:meth:`ee.Geometry.geetools.keepType `: :docstring:`geetools.GeometryAccessor.keepType` +- :docstring:`ee.Geometry.geetools.keepType` ee.Image ^^^^^^^^ @@ -164,63 +164,63 @@ ee.Image Constructor ########### -- :py:meth:`ee.Image.geetools.full `: :docstring:`geetools.ImageAccessor.full` -- :py:meth:`ee.Image.geetools.fullLike `: :docstring:`geetools.ImageAccessor.fullLike` +- :docstring:`ee.Image.geetools.full` +- :docstring:`ee.Image.geetools.fullLike` Band manipulation ################# -- :py:meth:`ee.Image.geetools.addDate `: :docstring:`geetools.ImageAccessor.addDate` -- :py:meth:`ee.Image.geetools.addSuffix `: :docstring:`geetools.ImageAccessor.addSuffix` -- :py:meth:`ee.Image.geetools.addPrefix `: :docstring:`geetools.ImageAccessor.addPrefix` -- :py:meth:`ee.Image.geetools.rename `: :docstring:`geetools.ImageAccessor.rename` -- :py:meth:`ee.Image.geetools.remove `: :docstring:`geetools.ImageAccessor.remove` -- :py:meth:`ee.Image.geetools.doyToDate `: :docstring:`geetools.ImageAccessor.doyToDate` -- :py:meth:`ee.Image.geetools.negativeClip `: :docstring:`geetools.ImageAccessor.negativeClip` -- :py:meth:`ee.Image.geetools.gauss `: :docstring:`geetools.ImageAccessor.gauss` -- :py:meth:`ee.Image.geetools.repeat `: :docstring:`geetools.ImageAccessor.repeat` +- :docstring:`ee.Image.geetools.addDate` +- :docstring:`ee.Image.geetools.addSuffix` +- :docstring:`ee.Image.geetools.addPrefix` +- :docstring:`ee.Image.geetools.rename` +- :docstring:`ee.Image.geetools.remove` +- :docstring:`ee.Image.geetools.doyToDate` +- :docstring:`ee.Image.geetools.negativeClip` +- :docstring:`ee.Image.geetools.gauss` +- :docstring:`ee.Image.geetools.repeat` Data extraction ############### -- :py:meth:`ee.Image.geetools.getValues `: :docstring:`geetools.ImageAccessor.getValues` -- :py:meth:`ee.Image.geetools.minScale `: :docstring:`geetools.ImageAccessor.minScale` -- :py:meth:`ee.Image.geetools.reduceBands `: :docstring:`geetools.ImageAccessor.reduceBands` -- :py:meth:`ee.Image.geetools.format `: :docstring:`geetools.ImageAccessor.format` -- :py:meth:`ee.Image.geetools.index_list `: :docstring:`geetools.ImageAccessor.index_list` -- :py:meth:`ee.Image.geetools.spectralIndices `: :docstring:`geetools.ImageAccessor.spectralIndices` -- :py:meth:`ee.Image.geetools.getScaleParams `: :docstring:`geetools.ImageAccessor.getScaleParams` -- :py:meth:`ee.Image.geetools.getOffsetParams `: :docstring:`geetools.ImageAccessor.getOffsetParams` -- :py:meth:`ee.Image.geetools.getSTAC `: :docstring:`geetools.ImageAccessor.getSTAC` -- :py:meth:`ee.Image.geetools.getDOI `: :docstring:`geetools.ImageAccessor.getDOI` -- :py:meth:`ee.Image.geetools.getCitation `: :docstring:`geetools.ImageAccessor.getCitation` +- :docstring:`ee.Image.geetools.getValues` +- :docstring:`ee.Image.geetools.minScale` +- :docstring:`ee.Image.geetools.reduceBands` +- :docstring:`ee.Image.geetools.format` +- :docstring:`ee.Image.geetools.index_list` +- :docstring:`ee.Image.geetools.spectralIndices` +- :docstring:`ee.Image.geetools.getScaleParams` +- :docstring:`ee.Image.geetools.getOffsetParams` +- :docstring:`ee.Image.geetools.getSTAC` +- :docstring:`ee.Image.geetools.getDOI` +- :docstring:`ee.Image.geetools.getCitation` Data manipulation ################# -- :py:meth:`ee.Image.geetools.doyToDate `: :docstring:`geetools.ImageAccessor.doyToDate` -- :py:meth:`ee.Image.geetools.clipOnCollection `: :docstring:`geetools.ImageAccessor.clipOnCollection` -- :py:meth:`ee.Image.geetools.bufferMask `: :docstring:`geetools.ImageAccessor.bufferMask` -- :py:meth:`ee.Image.geetools.removeZeros `: :docstring:`geetools.ImageAccessor.removeZeros` -- :py:meth:`ee.Image.geetools.interpolateBands `: :docstring:`geetools.ImageAccessor.interpolateBands` -- :py:meth:`ee.Image.geetools.isletMask `: :docstring:`geetools.ImageAccessor.isletMask` -- :py:meth:`ee.Image.geetools.scaleAndOffset `: :docstring:`geetools.ImageAccessor.scaleAndOffset` -- :py:meth:`ee.Image.geetools.preprocess `: :docstring:`geetools.ImageAccessor.preprocess` -- :py:meth:`ee.Image.geetools.panSharpen `: :docstring:`geetools.ImageAccessor.panSharpen` -- :py:meth:`ee.Image.geetools.tasseledCap `: :docstring:`geetools.ImageAccessor.tasseledCap` -- :py:meth:`ee.Image.geetools.matchHistogram `: :docstring:`geetools.ImageAccessor.matchHistogram` -- :py:meth:`ee.Image.geetools.maskClouds `: :docstring:`geetools.ImageAccessor.maskClouds` +- :docstring:`ee.Image.geetools.doyToDate` +- :docstring:`ee.Image.geetools.clipOnCollection` +- :docstring:`ee.Image.geetools.bufferMask` +- :docstring:`ee.Image.geetools.removeZeros` +- :docstring:`ee.Image.geetools.interpolateBands` +- :docstring:`ee.Image.geetools.isletMask` +- :docstring:`ee.Image.geetools.scaleAndOffset` +- :docstring:`ee.Image.geetools.preprocess` +- :docstring:`ee.Image.geetools.panSharpen` +- :docstring:`ee.Image.geetools.tasseledCap` +- :docstring:`ee.Image.geetools.matchHistogram` +- :docstring:`ee.Image.geetools.maskClouds` Converter ######### -- :py:meth:`ee.Image.geetools.toGrid `: :docstring:`geetools.ImageAccessor.toGrid` +- :docstring:`ee.Image.geetools.toGrid` Properties ########## -- :py:meth:`ee.Image.geetools.removeProperties `: :docstring:`geetools.ImageAccessor.removeProperties` +- :docstring:`ee.Image.geetools.removeProperties` ee.ImageCollection ^^^^^^^^^^^^^^^^^^ @@ -228,52 +228,52 @@ ee.ImageCollection Data manipulation ################# -- :py:meth:`ee.ImageCollection.geetools.maskClouds `: :docstring:`geetools.ImageCollectionAccessor.maskClouds` -- :py:meth:`ee.ImageCollection.geetools.closest `: :docstring:`geetools.ImageCollectionAccessor.closest` -- :py:meth:`ee.ImageCollection.geetools.scaleAndOffset `: :docstring:`geetools.ImageCollectionAccessor.scaleAndOffset` -- :py:meth:`ee.ImageCollection.geetools.preprocess `: :docstring:`geetools.ImageCollectionAccessor.preprocess` -- :py:meth:`ee.ImageCollection.geetools.panSharpen `: :docstring:`geetools.ImageCollectionAccessor.panSharpen` -- :py:meth:`ee.ImageCollection.geetools.tasseledCap `: :docstring:`geetools.ImageCollectionAccessor.tasseledCap` -- :py:meth:`ee.ImageCollection.geetools.append `: :docstring:`geetools.ImageCollectionAccessor.append` -- :py:meth:`ee.ImageCollection.geetools.outliers `: :docstring:`geetools.ImageCollectionAccessor.outliers` +- :docstring:`ee.ImageCollection.geetools.maskClouds` +- :docstring:`ee.ImageCollection.geetools.closest` +- :docstring:`ee.ImageCollection.geetools.scaleAndOffset` +- :docstring:`ee.ImageCollection.geetools.preprocess` +- :docstring:`ee.ImageCollection.geetools.panSharpen` +- :docstring:`ee.ImageCollection.geetools.tasseledCap` +- :docstring:`ee.ImageCollection.geetools.append` +- :docstring:`ee.ImageCollection.geetools.outliers` Data extraction ############### -- :py:meth:`ee.ImageCollection.geetools.spectralIndices `: :docstring:`geetools.ImageCollectionAccessor.spectralIndices` -- :py:meth:`ee.ImageCollection.geetools.getScaleParams `: :docstring:`geetools.ImageCollectionAccessor.getScaleParams` -- :py:meth:`ee.ImageCollection.geetools.getOffsetParams `: :docstring:`geetools.ImageCollectionAccessor.getOffsetParams` -- :py:meth:`ee.ImageCollection.geetools.getDOI `: :docstring:`geetools.ImageCollectionAccessor.getDOI` -- :py:meth:`ee.ImageCollection.geetools.getCitation `: :docstring:`geetools.ImageCollectionAccessor.getCitation` -- :py:meth:`ee.ImageCollection.geetools.getSTAC `: :docstring:`geetools.ImageCollectionAccessor.getSTAC` -- :py:meth:`ee.ImageCollection.geetools.collectionMask `: :docstring:`geetools.ImageCollectionAccessor.collectionMask` -- :py:meth:`ee.ImageCollection.geetools.iloc `: :docstring:`geetools.ImageCollectionAccessor.iloc` -- :py:meth:`ee.ImageCollection.geetools.integral `: :docstring:`geetools.ImageCollectionAccessor.integral` -- :py:meth:`ee.ImageCollection.geetools.aggregateArray `: :docstring:`geetools.ImageCollectionAccessor.aggregateArray` -- :py:meth:`ee.ImageCollection.geetools.validPixel `: :docstring:`geetools.ImageCollectionAccessor.validPixel` +- :docstring:`ee.ImageCollection.geetools.spectralIndices` +- :docstring:`ee.ImageCollection.geetools.getScaleParams` +- :docstring:`ee.ImageCollection.geetools.getOffsetParams` +- :docstring:`ee.ImageCollection.geetools.getDOI` +- :docstring:`ee.ImageCollection.geetools.getCitation` +- :docstring:`ee.ImageCollection.geetools.getSTAC` +- :docstring:`ee.ImageCollection.geetools.collectionMask` +- :docstring:`ee.ImageCollection.geetools.iloc` +- :docstring:`ee.ImageCollection.geetools.integral` +- :docstring:`ee.ImageCollection.geetools.aggregateArray` +- :docstring:`ee.ImageCollection.geetools.validPixel` Filter ###### -- :py:meth:`ee.ImageCollection.geetools.containsBandNames `: :docstring:`geetools.ImageCollectionAccessor.containsBandNames` -- :py:meth:`ee.ImageCollection.geetools.containsAllBands `: :docstring:`geetools.ImageCollectionAccessor.containsAllBands` -- :py:meth:`ee.ImageCollection.geetools.containsAnyBands `: :docstring:`geetools.ImageCollectionAccessor.containsAnyBands` +- :docstring:`ee.ImageCollection.geetools.containsBandNames` +- :docstring:`ee.ImageCollection.geetools.containsAllBands` +- :docstring:`ee.ImageCollection.geetools.containsAnyBands` Converter ######### -- :py:meth:`ee.ImageCollection.geetools.to_xarray `: :docstring:`geetools.ImageCollectionAccessor.to_xarray` +- :docstring:`ee.ImageCollection.geetools.to_xarray` ee.Initialize ^^^^^^^^^^^^^ -- :py:meth:`ee.Initialize.geetools.from_user `: :docstring:`geetools.InitializeAccessor.from_user` -- :py:meth:`ee.Initialize.geetools.project_id `: :docstring:`geetools.InitializeAccessor.project_id` +- :docstring:`ee.Initialize.geetools.from_user` +- :docstring:`ee.Initialize.geetools.project_id` ee.Join ^^^^^^^ -- :py:meth:`ee.Join.geetools.byProperty `: :docstring:`geetools.JoinAccessor.byProperty` +- :docstring:`ee.Join.geetools.byProperty` ee.List ^^^^^^^ @@ -281,35 +281,35 @@ ee.List Constructor ########### -- :py:meth:`ee.List.geetools.sequence `: :docstring:`geetools.ListAccessor.sequence` -- :py:meth:`ee.List.geetools.zip `: :docstring:`geetools.ListAccessor.zip` +- :docstring:`ee.List.geetools.sequence` +- :docstring:`ee.List.geetools.zip` operations ########## -- :py:meth:`ee.List.geetools.product `: :docstring:`geetools.ListAccessor.product` -- :py:meth:`ee.List.geetools.complement `: :docstring:`geetools.ListAccessor.complement` -- :py:meth:`ee.List.geetools.intersection `: :docstring:`geetools.ListAccessor.intersection` -- :py:meth:`ee.List.geetools.union `: :docstring:`geetools.ListAccessor.union` -- :py:meth:`ee.List.geetools.delete `: :docstring:`geetools.ListAccessor.delete` -- :py:meth:`ee.List.geetools.replaceMany `: :docstring:`geetools.ListAccessor.replaceMany` +- :docstring:`ee.List.geetools.product` +- :docstring:`ee.List.geetools.complement` +- :docstring:`ee.List.geetools.intersection` +- :docstring:`ee.List.geetools.union` +- :docstring:`ee.List.geetools.delete` +- :docstring:`ee.List.geetools.replaceMany` Converter ######### -- :py:meth:`ee.List.geetools.join `: :docstring:`geetools.ListAccessor.join` -- :py:meth:`ee.List.geetools.toStrings `: :docstring:`geetools.ListAccessor.toStrings` +- :docstring:`ee.List.geetools.join` +- :docstring:`ee.List.geetools.toStrings` ee.Number ^^^^^^^^^ -- :py:meth:`ee.Number.geetools.truncate `: :docstring:`geetools.NumberAccessor.truncate` +- :docstring:`ee.Number.geetools.truncate` ee.String ^^^^^^^^^ -- :py:meth:`ee.String.geetools.eq `: :docstring:`geetools.StringAccessor.eq` -- :py:meth:`ee.String.geetools.format `: :docstring:`geetools.StringAccessor.format` +- :docstring:`ee.String.geetools.eq` +- :docstring:`ee.String.geetools.format` Added classes ------------- @@ -319,14 +319,14 @@ ee.Float .. note:: - This object does not exist in the original API. It is a custom Placeholder Float class to be used in the :py:meth:`ee.ComputedObject.isInstance ` method. + This object does not exist in the original API. It is a custom Placeholder Float class to be used in the :py:meth:`ee.ComputedObject.isInstance` method. ee.Integer ^^^^^^^^^^ .. note:: - This object does not exist in the original API. It is a custom Placeholder Float class to be used in the :py:meth:`ee.ComputedObject.isInstance ` method. + This object does not exist in the original API. It is a custom Placeholder Float class to be used in the :py:meth:`ee.ComputedObject.isInstance` method. ee.Asset ^^^^^^^^ @@ -338,46 +338,46 @@ ee.Asset Constructor ########### -- :py:meth:`ee.Asset.home `: :docstring:`geetools.Asset.home` +- :docstring:`ee.Asset.home` Operation ######### -- :py:meth:`ee.Asset.as_posix `: :docstring:`geetools.Asset.as_posix` -- :py:meth:`ee.Asset.as_uri `: :docstring:`geetools.Asset.as_uri` -- :py:meth:`ee.Asset.is_absolute `: :docstring:`geetools.Asset.is_absolute` -- :py:meth:`ee.Asset.is_user_project `: :docstring:`geetools.Asset.is_user_project` -- :py:meth:`ee.Asset.expanduser `: :docstring:`geetools.Asset.expanduser` -- :py:meth:`ee.Asset.exists `: :docstring:`geetools.Asset.exists` -- :py:meth:`ee.Asset.is_relative_to `: :docstring:`geetools.Asset.is_relative_to` -- :py:meth:`ee.Asset.joinpath `: :docstring:`geetools.Asset.joinpath` -- :py:meth:`ee.Asset.match `: :docstring:`geetools.Asset.match` -- :py:meth:`ee.Asset.with_name `: :docstring:`geetools.Asset.with_name` -- :py:meth:`ee.Asset.is_image `: :docstring:`geetools.Asset.is_image` -- :py:meth:`ee.Asset.is_image_collection `: :docstring:`geetools.Asset.is_image_collection` -- :py:meth:`ee.Asset.is_feature_collection `: :docstring:`geetools.Asset.is_feature_collection` -- :py:meth:`ee.Asset.is_folder `: :docstring:`geetools.Asset.is_folder` -- :py:meth:`ee.Asset.is_project `: :docstring:`geetools.Asset.is_project` -- :py:meth:`ee.Asset.is_type `: :docstring:`geetools.Asset.is_type` -- :py:meth:`ee.Asset.iterdir `: :docstring:`geetools.Asset.iterdir` -- :py:meth:`ee.Asset.mkdir `: :docstring:`geetools.Asset.mkdir` -- :py:meth:`ee.Asset.move `: :docstring:`geetools.Asset.move` -- :py:meth:`ee.Asset.rmdir `: :docstring:`geetools.Asset.rmdir` -- :py:meth:`ee.Asset.unlink `: :docstring:`geetools.Asset.unlink` -- :py:meth:`ee.Asset.delete `: :docstring:`geetools.Asset.delete` -- :py:meth:`ee.Asset.copy `: :docstring:`geetools.Asset.copy` -- :py:meth:`ee.Asset.glob `: :docstring:`geetools.Asset.glob` -- :py:meth:`ee.Asset.rglob `: :docstring:`geetools.Asset.rglob` -- :py:meth:`ee.Asset.setProperties `: :docstring:`geetools.Asset.setProperties` +- :docstring:`ee.Asset.as_posix` +- :docstring:`ee.Asset.as_uri` +- :docstring:`ee.Asset.is_absolute` +- :docstring:`ee.Asset.is_user_project` +- :docstring:`ee.Asset.expanduser` +- :docstring:`ee.Asset.exists` +- :docstring:`ee.Asset.is_relative_to` +- :docstring:`ee.Asset.joinpath` +- :docstring:`ee.Asset.match` +- :docstring:`ee.Asset.with_name` +- :docstring:`ee.Asset.is_image` +- :docstring:`ee.Asset.is_image_collection` +- :docstring:`ee.Asset.is_feature_collection` +- :docstring:`ee.Asset.is_folder` +- :docstring:`ee.Asset.is_project` +- :docstring:`ee.Asset.is_type` +- :docstring:`ee.Asset.iterdir` +- :docstring:`ee.Asset.mkdir` +- :docstring:`ee.Asset.move` +- :docstring:`ee.Asset.rmdir` +- :docstring:`ee.Asset.unlink` +- :docstring:`ee.Asset.delete` +- :docstring:`ee.Asset.copy` +- :docstring:`ee.Asset.glob` +- :docstring:`ee.Asset.rglob` +- :docstring:`ee.Asset.setProperties` Property ######## -- :py:meth:`ee.Asset.parts `: :docstring:`geetools.Asset.parts` -- :py:meth:`ee.Asset.parent `: :docstring:`geetools.Asset.parent` -- :py:meth:`ee.Asset.parents `: :docstring:`geetools.Asset.parents` -- :py:meth:`ee.Asset.name `: :docstring:`geetools.Asset.name` -- :py:meth:`ee.Asset.st_size `: :docstring:`geetools.Asset.st_size` -- :py:meth:`ee.Asset.type `: :docstring:`geetools.Asset.type` -- :py:meth:`ee.Asset.owner `: :docstring:`geetools.Asset.owner` +- :docstring:`ee.Asset.parts` +- :docstring:`ee.Asset.parent` +- :docstring:`ee.Asset.parents` +- :docstring:`ee.Asset.name` +- :docstring:`ee.Asset.st_size` +- :docstring:`ee.Asset.type` +- :docstring:`ee.Asset.owner` diff --git a/docs/usage/asset.ipynb b/docs/usage/asset.ipynb index 33d7e051..fae2e8dd 100644 --- a/docs/usage/asset.ipynb +++ b/docs/usage/asset.ipynb @@ -251,8 +251,8 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`iterdir `: {docstring}`geetools.Asset.iterdir`\n", - "- {py:meth}`is_folder `: {docstring}`geetools.Asset.is_folder`\n", + "- {docstring}`ee.Asset.iterdir`\n", + "- {{docstring}`ee.Asset.is_folder`\n", "```" ] }, @@ -316,9 +316,9 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`iterdir `: {docstring}`geetools.Asset.iterdir`\n", - "- {py:meth}`glob `: {docstring}`geetools.Asset.glob`\n", - "- {py:meth}`is_image `: {docstring}`geetools.Asset.is_image`\n", + "- {docstring}`ee.Asset.iterdir`\n", + "- {docstring}`ee.Asset.glob`\n", + "- {docstring}`ee.Asset.is_image`\n", "```" ] }, @@ -375,7 +375,7 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`exists `: {docstring}`geetools.Asset.exists`\n", + "- {docstring}`ee.Asset.exists`\n", "```" ] }, @@ -557,7 +557,7 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`parts `: {docstring}`geetools.Asset.parts`\n", + "- {docstring}`ee.Asset.parts`\n", "```" ] }, @@ -570,8 +570,8 @@ "Asset parent containers can be access either by the `parent` property or the `parents` property. Note This is a purely lexical operation and the parent is not checked to exist.\n", "\n", "```{api}\n", - "- {py:meth}`parent `: {docstring}`geetools.Asset.parent`\n", - "- {py:meth}`parents `: {docstring}`geetools.Asset.parents`\n", + "- {docstring}`ee.Asset.parent`\n", + "- {docstring}`ee.Asset.parents`\n", "```" ] }, @@ -627,7 +627,7 @@ "A string representing the final path component can be used to get the name of the asset.add\n", "\n", "```{api}\n", - "- {py:meth}`name `: {docstring}`geetools.Asset.name`\n", + "- {docstring}`ee.Asset.name`\n", "```" ] }, @@ -670,7 +670,7 @@ "It's possible to check if files are related between one another using the following methods:\n", "\n", "```{api}\n", - "- {py:meth}`is_relative_to `: {docstring}`geetools.Asset.is_relative_to`" + "- {docstring}`ee.Asset.is_relative_to`" ] }, { @@ -704,7 +704,7 @@ "One can create a siblings asset in the same container by using the `with_name()` method:\n", "\n", "```{api} \n", - "- {py:meth}`with_name `: {docstring}`geetools.Asset.with_name`\n", + "- {docstring}`ee.Asset.with_name`\n", "```" ] }, @@ -738,7 +738,7 @@ "One can use some unix-like descriptors in it's Asset constructor parameters. If so before using the Asset object, it is necessary to resolve these symbols. The method `expanduser` does that.\n", "\n", "```{api}\n", - "- {py:meth}`expanduser `: {docstring}`geetools.Asset.expanduser`\n", + "- {py:meth}`expanduser `: {docstring}`ee.Asset.expanduser`\n", "```" ] }, @@ -772,7 +772,7 @@ "One can check if an asset exists using the `exists` method:\n", "\n", "```{api}\n", - "- {py:meth}`exists `: {docstring}`geetools.Asset.exists`\n", + "- {py:meth}`exists `: {docstring}`ee.Asset.exists`\n", "```" ] }, @@ -827,7 +827,7 @@ "As Earth Engine is not using any file extention to differentiate the asset type, one can use the `is_type` method with any of the following types: `IMAGE`, `IMAGE_COLLECTION`, `FOLDER`, `TABLE`, `FEATURE_COLLECTION`, `UNKNOWN`.\n", "\n", "```{api}\n", - "- {py:meth}`is_type `: {docstring}`geetools.Asset.is_type`\n", + "- {py:meth}`is_type `: {docstring}`ee.Asset.is_type`\n", "```" ] }, @@ -883,7 +883,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Many other useful methods are available and are described in the {py:class}`API documentation `." + "Many other useful methods are available and are described in the {py:class}`API documentation `." ] } ], diff --git a/docs/usage/plot/map-featurecollection.ipynb b/docs/usage/plot/map-featurecollection.ipynb index 930f4c26..04ec80dc 100644 --- a/docs/usage/plot/map-featurecollection.ipynb +++ b/docs/usage/plot/map-featurecollection.ipynb @@ -106,7 +106,7 @@ "## Map Vector\n", "\n", "```{api}\n", - "{py:meth}`plot `: {docstring}`geetools.FeatureCollectionAccessor.plot`\n", + "{docstring}`ee.FeatureCollection.geetools.plot`\n", "```\n", "\n", "An `ee.FeatureCollection` is a vector representation of geographical properties. A user can be interested by either the property evolution across the landscape or the geometries associated with it. The {py:meth}`plot ` is coverinig both use cases. \n", diff --git a/docs/usage/plot/plot-featurecollection.ipynb b/docs/usage/plot/plot-featurecollection.ipynb index 6187fc14..0a9b00a7 100644 --- a/docs/usage/plot/plot-featurecollection.ipynb +++ b/docs/usage/plot/plot-featurecollection.ipynb @@ -177,8 +177,8 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`plot_by_features `: {docstring}`geetools.FeatureCollectionAccessor.plot_by_features`\n", - "- {py:meth}`byFeatures `: {docstring}`geetools.FeatureCollectionAccessor.byFeatures`\n", + "- {docstring}`geetools.FeatureCollectionAccessor.plot_by_features`\n", + "- {docstring}`ee.FeatureCollection.geetools.byFeatures`\n", "```" ] }, @@ -477,8 +477,8 @@ "metadata": {}, "source": [ "```{api}\n", - "{py:meth}`plot_by_properties `: {docstring}`geetools.FeatureCollectionAccessor.plot_by_properties`\n", - "{py:meth}`byProperties `: {docstring}`geetools.FeatureCollectionAccessor.byProperties`\n", + "- {docstring}`ee.FeatureCollection.geetools.plot_by_properties`\n", + "- {docstring}`ee.FeatureCollection.geetools.byProperties`\n", "```" ] }, @@ -625,7 +625,7 @@ "## Plot hist\n", "\n", "```{api}\n", - "{py:meth}`plot_hist `: {docstring}`geetools.FeatureCollectionAccessor.plot_hist`\n", + "{docstring}`ee.FeatureCollection.geetools.plot_hist`\n", "```\n", "\n", "The x-axis is defined by value bins for the range of values of a selected property; the y-axis is the number of elements in the given bin." diff --git a/docs/usage/plot/plot-image.ipynb b/docs/usage/plot/plot-image.ipynb index f143e098..501b9c2d 100644 --- a/docs/usage/plot/plot-image.ipynb +++ b/docs/usage/plot/plot-image.ipynb @@ -177,8 +177,8 @@ "metadata": {}, "source": [ "```{api}\n", - "- {py:meth}`plot_by_regions `: {docstring}`geetools.ImageAccessor.plot_by_regions`\n", - "- {py:meth}`byRegions `: {docstring}`geetools.ImageAccessor.byRegions`\n", + "- {docstring}`ee.Image.geetools.plot_by_regions`\n", + "- {docstring}`ee.Image.geetools.byRegions`\n", "```" ] }, diff --git a/geetools/__init__.py b/geetools/__init__.py index 9a77e1a3..fb236922 100644 --- a/geetools/__init__.py +++ b/geetools/__init__.py @@ -5,7 +5,7 @@ from .accessors import geetools # it needs to be imported first as it's the mother class -from . import ComputedObject +from .ee_computed_object import * # reproduce older structure of the lib (deprecated) # will be removed along the deprecation cycle @@ -14,24 +14,24 @@ from .tools import imagecollection # then we extend all the other classes -from .Asset import Asset -from .Date import DateAccessor -from .Dictionary import DictionaryAccessor -from .Feature import FeatureAccessor -from .FeatureCollection import FeatureCollectionAccessor -from .Filter import FilterAccessor -from .Geometry import GeometryAccessor -from .Image import ImageAccessor -from .Join import JoinAccessor -from .List import ListAccessor -from .Number import NumberAccessor -from .String import StringAccessor -from .ImageCollection import ImageCollectionAccessor -from .Initialize import InitializeAccessor -from .Authenticate import AuthenticateAccessor -from .Array import ArrayAccessor -from .DateRange import DateRangeAccessor -from .Export import ExportAccessor +from .ee_asset import Asset +from .ee_date import DateAccessor +from .ee_dictionary import DictionaryAccessor +from .ee_feature import FeatureAccessor +from .ee_feature_collection import FeatureCollectionAccessor +from .ee_filter import FilterAccessor +from .ee_geometry import GeometryAccessor +from .ee_image import ImageAccessor +from .ee_join import JoinAccessor +from .ee_list import ListAccessor +from .ee_number import NumberAccessor +from .ee_string import StringAccessor +from .ee_image_collection import ImageCollectionAccessor +from .ee_initialize import InitializeAccessor +from .ee_authenticate import AuthenticateAccessor +from .ee_array import ArrayAccessor +from .ee_date_range import DateRangeAccessor +from .ee_export import ExportAccessor from .ee_profiler import Profiler __title__ = "geetools" diff --git a/geetools/Array.py b/geetools/ee_array.py similarity index 100% rename from geetools/Array.py rename to geetools/ee_array.py diff --git a/geetools/Asset.py b/geetools/ee_asset.py similarity index 97% rename from geetools/Asset.py rename to geetools/ee_asset.py index caeb58d6..47382be7 100644 --- a/geetools/Asset.py +++ b/geetools/ee_asset.py @@ -451,8 +451,8 @@ def iterdir(self, recursive: bool = False) -> list: recursive: If True, get all the children recursively. Defaults to False. See Also: - - :py:meth:`glob `: :docstring:`geetools.Asset.glob` - - :py:meth:`rglob `: :docstring:`geetools.Asset.rglob` + - :docstring:`ee.Asset.glob` + - :docstring:`ee.Asset.rglob` Examples: .. code-block:: python @@ -698,8 +698,8 @@ def glob(self, pattern: str) -> list: pattern: The pattern to match with the asset name. See Also: - - :py:meth:`iterdir `: :docstring:`geetools.Asset.iterdir` - - :py:meth:`glob `: :docstring:`geetools.Asset.rglob` + - :docstring:`ee.Asset.iterdir` + - :docstring:`ee.Asset.rglob` Examples: .. code-block:: python @@ -716,8 +716,8 @@ def rglob(self, pattern: str) -> list: pattern: The pattern to match with the asset name. See Also: - - :py:meth:`glob `: :docstring:`geetools.Asset.glob` - - :py:meth:`iterdir `: :docstring:`geetools.Asset.iterdir` + - :docstring:`ee.Asset.glob` + - :docstring:`ee.Asset.iterdir` Examples: .. code-block:: python diff --git a/geetools/Authenticate.py b/geetools/ee_authenticate.py similarity index 100% rename from geetools/Authenticate.py rename to geetools/ee_authenticate.py diff --git a/geetools/ComputedObject.py b/geetools/ee_computed_object.py similarity index 100% rename from geetools/ComputedObject.py rename to geetools/ee_computed_object.py diff --git a/geetools/Date.py b/geetools/ee_date.py similarity index 100% rename from geetools/Date.py rename to geetools/ee_date.py diff --git a/geetools/DateRange.py b/geetools/ee_date_range.py similarity index 100% rename from geetools/DateRange.py rename to geetools/ee_date_range.py diff --git a/geetools/Dictionary.py b/geetools/ee_dictionary.py similarity index 100% rename from geetools/Dictionary.py rename to geetools/ee_dictionary.py diff --git a/geetools/Export.py b/geetools/ee_export.py similarity index 100% rename from geetools/Export.py rename to geetools/ee_export.py diff --git a/geetools/Feature.py b/geetools/ee_feature.py similarity index 100% rename from geetools/Feature.py rename to geetools/ee_feature.py diff --git a/geetools/FeatureCollection.py b/geetools/ee_feature_collection.py similarity index 86% rename from geetools/FeatureCollection.py rename to geetools/ee_feature_collection.py index 7aa66f0b..14d09568 100644 --- a/geetools/FeatureCollection.py +++ b/geetools/ee_feature_collection.py @@ -154,8 +154,8 @@ def byProperties( A dictionary with all the properties as keys and their values in each feaure as a list. See Also: - - :py:meth:`byFeatures `: :docstring:`geetools.FeatureCollectionAccessor.byFeatures` - - :py:meth:`plot_by_properties `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_properties` + - :docstring:`ee.FeatureCollection.geetools.byFeatures` + - :docstring:`ee.FeatureCollection.geetools.plot_by_properties` Example: .. code-block:: python @@ -213,8 +213,8 @@ def byFeatures( A dictionary with all the feature ids as keys and their properties as a dictionary. See Also: - - :py:meth:`byProperties `: :docstring:`geetools.FeatureCollectionAccessor.byProperties` - - :py:meth:`plot_by_features `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_features` + - :docstring:`ee.FeatureCollection.geetools.byProperties` + - :docstring:`ee.FeatureCollection.geetools.plot_by_features` Examples: .. code-block:: python @@ -274,10 +274,10 @@ def plot_by_features( kwargs: Additional arguments from the ``pyplot`` function. See Also: - - :py:meth:`byFeatures `: :docstring:`geetools.FeatureCollectionAccessor.byFeatures` - - :py:meth:`plot_by_properties `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_properties` - - :py:meth:`plot_hist `: :docstring:`geetools.FeatureCollectionAccessor.plot_hist` - - :py:meth:`plot `: :docstring:`geetools.FeatureCollectionAccessor.plot` + - :docstring:`ee.FeatureCollection.geetools.byFeatures` + - :docstring:`ee.FeatureCollection.geetools.plot_by_properties` + - :docstring:`ee.FeatureCollection.geetools.plot_hist` + - :docstring:`ee.FeatureCollection.geetools.plot` Examples: .. code-block:: python @@ -327,10 +327,10 @@ def plot_by_properties( kwargs: Additional arguments from the ``pyplot`` function. See Also: - - :py:meth:`byProperties `: :docstring:`geetools.FeatureCollectionAccessor.byProperties` - - :py:meth:`plot_by_features `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_features` - - :py:meth:`plot_hist `: :docstring:`geetools.FeatureCollectionAccessor.plot_hist` - - :py:meth:`plot `: :docstring:`geetools.FeatureCollectionAccessor.plot` + - :docstring:`ee.FeatureCollection.geetools.byProperties` + - :docstring:`ee.FeatureCollection.geetools.plot_by_features` + - :docstring:`ee.FeatureCollection.geetools.plot_hist` + - :docstring:`ee.FeatureCollection.geetools.plot` Examples: .. code-block:: python @@ -375,9 +375,9 @@ def plot_hist( kwargs: Additional arguments from the ``pyplot.hist`` function. See Also: - - :py:meth:`plot_by_features `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_features` - - :py:meth:`plot_by_properties `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_properties` - - :py:meth:`plot `: :docstring:`geetools.FeatureCollectionAccessor.plot` + - :docstring:`ee.FeatureCollection.geetools.plot_by_features` + - :docstring:`ee.FeatureCollection.geetools.plot_by_properties` + - :docstring:`ee.FeatureCollection.geetools.plot` Examples: .. code-block:: python @@ -444,9 +444,9 @@ def plot( color: The color to use for the boundaries. See Also: - - :py:meth:`plot_by_features `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_features` - - :py:meth:`plot_by_properties `: :docstring:`geetools.FeatureCollectionAccessor.plot_by_properties` - - :py:meth:`plot_hist `: :docstring:`geetools.FeatureCollectionAccessor.plot_hist` + - :docstring:`ee.FeatureCollection.geetools.plot_by_features` + - :docstring:`ee.FeatureCollection.geetools.plot_by_properties` + - :docstring:`ee.FeatureCollection.geetools.plot_hist` Examples: .. code-block:: python diff --git a/geetools/Filter.py b/geetools/ee_filter.py similarity index 100% rename from geetools/Filter.py rename to geetools/ee_filter.py diff --git a/geetools/Geometry.py b/geetools/ee_geometry.py similarity index 100% rename from geetools/Geometry.py rename to geetools/ee_geometry.py diff --git a/geetools/Image.py b/geetools/ee_image.py similarity index 97% rename from geetools/Image.py rename to geetools/ee_image.py index 1ee7f875..02d05349 100644 --- a/geetools/Image.py +++ b/geetools/ee_image.py @@ -1611,8 +1611,8 @@ def byBands( A dictionary with all the bands as keys and their values in each region as a list. See Also: - - :py:meth:`byRegions `: :docstring:`geetools.ImageAccessor.byRegions` - - :py:meth:`plot_by_bands `: :docstring:`geetools.ImageAccessor.plot_by_bands` + - :docstring:`ee.Image.geetools.byRegions` + - :docstring:`ee.Image.geetools.plot_by_bands` Examples: .. code-block:: python @@ -1688,8 +1688,8 @@ def byRegions( A dictionary with all the bands as keys and their values in each region as a list. See Also: - - :py:meth:`byBands `: :docstring:`geetools.ImageAccessor.byBands` - - :py:meth:`plot_by_bands `: :docstring:`geetools.ImageAccessor.plot_by_regions` + - :docstring:`ee.Image.geetools.byBands` + - :docstring:`ee.Image.geetools.plot_by_regions` Examples: .. code-block:: python @@ -1767,10 +1767,10 @@ def plot_by_regions( ax: The matplotlib axis to plot the data on. If None, a new figure is created. See Also: - - :py:meth:`byRegions `: :docstring:`geetools.ImageAccessor.byRegions` - - :py:meth:`byBands `: :docstring:`geetools.ImageAccessor.byBands` - - :py:meth:`plot_by_bands `: :docstring:`geetools.ImageAccessor.plot_by_bands` - - :py:meth:`plot_hist `: :docstring:`geetools.ImageAccessor.plot_hist + - :docstring:`ee.Image.geetools.byRegions` + - :docstring:`ee.Image.geetools.byBands` + - :docstring:`ee.Image.geetools.plot_by_bands` + - :docstring:`ee.Image.geetools.plot_hist Examples: .. code-block:: python @@ -1838,10 +1838,10 @@ def plot_by_bands( ax: The matplotlib axis to plot the data on. If None, a new figure is created. See Also: - - :py:meth:`byRegions `: :docstring:`geetools.ImageAccessor.byRegions` - - :py:meth:`byBands `: :docstring:`geetools.ImageAccessor.byBands` - - :py:meth:`plot_by_bands `: :docstring:`geetools.ImageAccessor.plot_by_regions` - - :py:meth:`plot_hist `: :docstring:`geetools.ImageAccessor.plot_hist + - :docstring:`ee.Image.geetools.byRegions` + - :docstring:`ee.Image.geetools.byBands` + - :docstring:`ee.Image.geetools.plot_by_regions` + - :docstring:`ee.Image.geetools.plot_hist Examples: .. code-block:: python @@ -1901,10 +1901,10 @@ def plot_hist( region: The region to compute the histogram in. Default is the image geometry. See Also: - - :py:meth:`byRegions `: :docstring:`geetools.ImageAccessor.byRegions` - - :py:meth:`byBands `: :docstring:`geetools.ImageAccessor.byBands` - - :py:meth:`plot_by_bands `: :docstring:`geetools.ImageAccessor.plot_by_bands` - - :py:meth:`plot_by_regions `: :docstring:`geetools.ImageAccessor.plot_by_regions + - :docstring:`ee.Image.geetools.byRegions` + - :docstring:`ee.Image.geetools.byBands` + - :docstring:`ee.Image.geetools.plot_by_bands` + - :docstring:`ee.Image.geetools.plot_by_regions Examples: .. code-block:: python diff --git a/geetools/ImageCollection.py b/geetools/ee_image_collection.py similarity index 100% rename from geetools/ImageCollection.py rename to geetools/ee_image_collection.py diff --git a/geetools/Initialize.py b/geetools/ee_initialize.py similarity index 100% rename from geetools/Initialize.py rename to geetools/ee_initialize.py diff --git a/geetools/Join.py b/geetools/ee_join.py similarity index 100% rename from geetools/Join.py rename to geetools/ee_join.py diff --git a/geetools/List.py b/geetools/ee_list.py similarity index 100% rename from geetools/List.py rename to geetools/ee_list.py diff --git a/geetools/Number.py b/geetools/ee_number.py similarity index 100% rename from geetools/Number.py rename to geetools/ee_number.py diff --git a/geetools/String.py b/geetools/ee_string.py similarity index 100% rename from geetools/String.py rename to geetools/ee_string.py