diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index af51649c51..0000000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = python -msphinx -SPHINXPROJ = geemap -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/ads.txt b/docs/ads.txt deleted file mode 100644 index 597cba2a8b..0000000000 --- a/docs/ads.txt +++ /dev/null @@ -1 +0,0 @@ -google.com, pub-6224089686474451, DIRECT, f08c47fec0942fa0 \ No newline at end of file diff --git a/docs/authors.rst b/docs/authors.rst deleted file mode 100644 index e122f914a8..0000000000 --- a/docs/authors.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../AUTHORS.rst diff --git a/docs/colormaps.md b/docs/colormaps.md index 7c24d7a31e..457bfa6403 100644 --- a/docs/colormaps.md +++ b/docs/colormaps.md @@ -1,3 +1,3 @@ -# colormaps module - +# colormaps module + ::: geemap.colormaps \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 7e8f8eda88..0000000000 --- a/docs/conf.py +++ /dev/null @@ -1,185 +0,0 @@ -#!/usr/bin/env python -# -# geemap documentation build configuration file, created by -# sphinx-quickstart on Fri Jun 9 13:47:02 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another -# directory, add these directories to sys.path here. If the directory is -# relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath("..")) - -import geemap - -# -- General configuration --------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.viewcode", - "sphinx.ext.napoleon", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - -# The master toctree document. -master_doc = "index" - -# General information about the project. -project = "geemap" -copyright = "2020, Qiusheng Wu" -author = "Qiusheng Wu" - -# The version info for the project you're documenting, acts as replacement -# for |version| and |release|, also used in various other places throughout -# the built documents. -# -# The short X.Y version. -version = geemap.__version__ -# The full version, including alpha/beta/rc tags. -release = geemap.__version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = 'alabaster' -html_theme = "sphinx_rtd_theme" -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -# if not on_rtd: # only import and set the theme if we're building docs locally -# import sphinx_rtd_theme -# html_theme = 'sphinx_rtd_theme' -# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# html_context = { -# 'css_files': [ -# '_static/theme_overrides.css' -# ] -# } -# else: -# html_context = { -# 'css_files': [ -# '//media.readthedocs.org/css/sphinx_rtd_theme.css', -# '//media.readthedocs.org/css/readthedocs-doc-embed.css', -# '_static/theme_overrides.css' -# ] -# } - -# Theme options are theme-specific and customize the look and feel of a -# theme further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - - -# -- Options for HTMLHelp output --------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = "geemapdoc" - - -# -- Options for LaTeX output ------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto, manual, or own class]). -latex_documents = [ - ( - master_doc, - "geemap.tex", - "geemap Documentation", - "Qiusheng Wu", - "manual", - ), -] - - -# -- Options for manual page output ------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "geemap", "geemap Documentation", [author], 1)] - - -# -- Options for Texinfo output ---------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "geemap", - "geemap Documentation", - author, - "geemap", - "One line description of project.", - "Miscellaneous", - ), -] diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index e582053ea0..0000000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst diff --git a/docs/geemap.rst b/docs/geemap.rst deleted file mode 100644 index a328896227..0000000000 --- a/docs/geemap.rst +++ /dev/null @@ -1,63 +0,0 @@ -geemap package -============== - -Submodules ----------- - -geemap.basemaps module ----------------------- - -.. automodule:: geemap.basemaps - :members: - :undoc-members: - :show-inheritance: - -geemap.cli module ------------------ - -.. automodule:: geemap.cli - :members: - :undoc-members: - :show-inheritance: - -geemap.conversion module ------------------------- - -.. automodule:: geemap.conversion - :members: - :undoc-members: - :show-inheritance: - -geemap.foliumap module ----------------------- - -.. automodule:: geemap.foliumap - :members: - :undoc-members: - :show-inheritance: - -geemap.geemap module --------------------- - -.. automodule:: geemap.geemap - :members: - :undoc-members: - :show-inheritance: - -geemap.legends module ---------------------- - -.. automodule:: geemap.legends - :members: - :undoc-members: - :show-inheritance: - - - -Module contents ---------------- - -.. automodule:: geemap - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/history.rst b/docs/history.rst deleted file mode 100644 index 250649964b..0000000000 --- a/docs/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../HISTORY.rst diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 6afa75034b..0000000000 --- a/docs/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -Welcome to geemap's documentation! -====================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - readme - installation - usage - modules - contributing - authors - history - -Indices and tables -================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 27148d4aba..0000000000 --- a/docs/installation.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. highlight:: shell - -============ -Installation -============ - - -Stable release --------------- - -To install geemap, run this command in your terminal: - -.. code-block:: console - - $ pip install geemap - -This is the preferred method to install geemap, as it will always install the most recent stable release. - -If you don't have `pip`_ installed, this `Python installation guide`_ can guide -you through the process. - -.. _pip: https://pip.pypa.io -.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/ - - -From sources ------------- - -The sources for geemap can be downloaded from the `Github repo`_. - -You can either clone the public repository: - -.. code-block:: console - - $ git clone git://github.com/gee-community/geemap - -Or download the `tarball`_: - -.. code-block:: console - - $ curl -OJL https://github.com/gee-community/geemap/tarball/master - -Once you have a copy of the source, you can install it with: - -.. code-block:: console - - $ python setup.py install - - -.. _Github repo: https://github.com/gee-community/geemap -.. _tarball: https://github.com/gee-community/geemap/tarball/master diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index b33ee32f5c..0000000000 --- a/docs/make.bat +++ /dev/null @@ -1,36 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=python -msphinx -) -set SOURCEDIR=. -set BUILDDIR=_build -set SPHINXPROJ=geemap - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The Sphinx module was not found. Make sure you have Sphinx installed, - echo.then set the SPHINXBUILD environment variable to point to the full - echo.path of the 'sphinx-build' executable. Alternatively you may add the - echo.Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% - -:end -popd diff --git a/docs/modules.rst b/docs/modules.rst deleted file mode 100644 index 87b51f62fd..0000000000 --- a/docs/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -Modules -======= - -.. toctree:: - :maxdepth: 4 - - geemap diff --git a/docs/readme.rst b/docs/readme.rst deleted file mode 100644 index 72a3355815..0000000000 --- a/docs/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/docs/source/geemap.rst b/docs/source/geemap.rst deleted file mode 100644 index a328896227..0000000000 --- a/docs/source/geemap.rst +++ /dev/null @@ -1,63 +0,0 @@ -geemap package -============== - -Submodules ----------- - -geemap.basemaps module ----------------------- - -.. automodule:: geemap.basemaps - :members: - :undoc-members: - :show-inheritance: - -geemap.cli module ------------------ - -.. automodule:: geemap.cli - :members: - :undoc-members: - :show-inheritance: - -geemap.conversion module ------------------------- - -.. automodule:: geemap.conversion - :members: - :undoc-members: - :show-inheritance: - -geemap.foliumap module ----------------------- - -.. automodule:: geemap.foliumap - :members: - :undoc-members: - :show-inheritance: - -geemap.geemap module --------------------- - -.. automodule:: geemap.geemap - :members: - :undoc-members: - :show-inheritance: - -geemap.legends module ---------------------- - -.. automodule:: geemap.legends - :members: - :undoc-members: - :show-inheritance: - - - -Module contents ---------------- - -.. automodule:: geemap - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst deleted file mode 100644 index bab03dd70b..0000000000 --- a/docs/source/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -geemap -====== - -.. toctree:: - :maxdepth: 4 - - geemap diff --git a/docs/usage.rst b/docs/usage.rst deleted file mode 100644 index 51ed7b96ad..0000000000 --- a/docs/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -===== -Usage -===== - -To use geemap in a project:: - - import geemap diff --git a/examples/template/template.py b/examples/template/template.py index b082dd8617..3ce68e0ff4 100644 --- a/examples/template/template.py +++ b/examples/template/template.py @@ -30,8 +30,8 @@ # %% """ -## Create an interactive map -The default basemap is `Google Maps`. [Additional basemaps](https://github.com/gee-community/geemap/blob/master/geemap/basemaps.py) can be added using the `Map.add_basemap()` function. +## Create an interactive map +The default basemap is `Google Maps`. [Additional basemaps](https://github.com/gee-community/geemap/blob/master/geemap/basemaps.py) can be added using the `Map.add_basemap()` function. """ # %% @@ -40,7 +40,7 @@ # %% """ -## Add Earth Engine Python script +## Add Earth Engine Python script """ # %% @@ -69,7 +69,7 @@ # %% """ -## Display Earth Engine data layers +## Display Earth Engine data layers """ # %% diff --git a/geemap/common.py b/geemap/common.py index 0752fdca1d..cc521ec10b 100644 --- a/geemap/common.py +++ b/geemap/common.py @@ -4177,7 +4177,7 @@ def ee_data_html(asset): bool(thumbnail_url) * f"""

Dataset Thumbnail

- + """ ) ## only community datasets have a code_url @@ -13892,7 +13892,7 @@ def _process_info(info): layer_info = ee_object.getInfo() if not layer_info: return None - + props = layer_info.get("properties", {}) layer_info["properties"] = dict(sorted(props.items())) @@ -14358,10 +14358,10 @@ def html_to_gradio(html, width="100%", height="500px", **kwargs): else: output.append(line + "\n") - return f"""""" diff --git a/geemap/conversion.py b/geemap/conversion.py index e19a336e1b..3d429a8306 100644 --- a/geemap/conversion.py +++ b/geemap/conversion.py @@ -4,7 +4,7 @@ - To convert a GEE Python script to Jupyter notebook: py_to_ipynb(in_file, template_file, out_file) - To convert all GEE Python scripts in a folder recursively to Jupyter notebooks: py_to_ipynb_dir(in_dir, template_file, out_dir) - To execute a Jupyter notebook and save output cells: execute_notebook(in_file) -- To execute all Jupyter notebooks in a folder recursively: execute_notebook_dir(in_dir) +- To execute all Jupyter notebooks in a folder recursively: execute_notebook_dir(in_dir) """ # *******************************************************************************# diff --git a/geemap/foliumap.py b/geemap/foliumap.py index ad03006014..0afaa4fc5c 100644 --- a/geemap/foliumap.py +++ b/geemap/foliumap.py @@ -2664,11 +2664,11 @@ def add_text( """ if background: - text = f"""
{text}
""" else: - text = f"""
{text}
""" self.add_html(text, position=position, **kwargs) @@ -2712,10 +2712,10 @@ def to_gradio(self, width="100%", height="500px", **kwargs): else: output.append(line + "\n") - return f"""""" def remove_labels(self, **kwargs): diff --git a/geemap/osm.py b/geemap/osm.py index 7bae357370..42bd9b516c 100644 --- a/geemap/osm.py +++ b/geemap/osm.py @@ -1,7 +1,7 @@ -"""The module contains functions for downloading OpenStreetMap data. It wraps the geometries module of the osmnx package -(see https://osmnx.readthedocs.io/en/stable/osmnx.html#module-osmnx.geometries). Credits to Geoff Boeing, the developer of the osmnx package. -Most functions for downloading OpenStreetMap data require tags of map features. The list of commonly used tags can be found at -https://wiki.openstreetmap.org/wiki/Map_features +"""The module contains functions for downloading OpenStreetMap data. It wraps the geometries module of the osmnx package +(see https://osmnx.readthedocs.io/en/stable/osmnx.html#module-osmnx.geometries). Credits to Geoff Boeing, the developer of the osmnx package. +Most functions for downloading OpenStreetMap data require tags of map features. The list of commonly used tags can be found at +https://wiki.openstreetmap.org/wiki/Map_features """ # *******************************************************************************#