added doc

Author: Nour-Cheour10

docs/europe_110.geo.json

@@ -0,0 +1,6 @@
+API Reference
+=============
+
+.. automodule:: ipyopenlayers.openlayers
+   :members:
+   :no-index:

docs/source/api_reference/index.rst

@@ -181,7 +181,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
 
 # Read The Docs
 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from

docs/source/conf.py

@@ -0,0 +1,40 @@
+Fullscreen Control
+==================
+
+
+The Fullscreen Control in `ipyopenlayers` allows users to toggle the map view between fullscreen and windowed modes. This control enhances the user experience by providing an easy way to expand the map to occupy the entire screen.
+
+
+Example
+-------
+
+
+.. jupyter-execute::
+
+
+   from ipyopenlayers import Map, FullScreen
+
+
+   # Create a map with initial zoom level and center coordinates
+   m = Map(center=[0, 0], zoom=2)
+
+
+   # Add a FullscreenControl to the map
+   fullscreen_control = FullScreen()
+   m.add_control(fullscreen_control)
+
+
+   # Display the map
+   m
+
+
+
+
+Attributes
+----------
+
+
+.. autoclass:: ipyopenlayers.openlayers.FullScreen
+  :members:
+
+

docs/source/controls/fullscreen_control.rst

@@ -0,0 +1,11 @@
+Controls
+===================
+Controls provide interactive elements on a map that allow users to manipulate the map view or access additional functionalities. These controls can include zoom buttons, layer switches, and other user interface elements that enhance the usability and functionality of the map.
+
+.. toctree::
+   :maxdepth: 1
+
+   zoomslider_control
+   scaleline_control
+   fullscreen_control
+   mouseposition_control

docs/source/controls/index.rst

@@ -0,0 +1,38 @@
+Mouse Position Control
+======================
+
+
+The Mouse Position Control in `ipyopenlayers` shows the geographical coordinates of the mouse pointer on the map. This control is useful for users who need to know the precise location of their cursor within the map view.
+
+
+Example
+-------
+
+
+.. jupyter-execute::
+
+
+   from ipyopenlayers import Map, MousePosition
+
+
+   # Create a map with initial zoom level and center coordinates
+   m = Map(center=[0, 0], zoom=2)
+
+
+   # Add a MousePositionControl to the map
+   mouseposition_control = MousePosition()
+   m.add_control(mouseposition_control)
+
+
+   # Display the map
+   m
+
+
+
+
+Attributes
+----------
+
+
+.. autoclass:: ipyopenlayers.openlayers.MousePosition
+  :members:

docs/source/controls/mouseposition_control.rst

@@ -0,0 +1,38 @@
+Scaleline Control
+=================
+
+
+The Scaleline Control in `ipyopenlayers` displays a scale line on the map, providing users with a visual reference for the map's scale. This helps users to understand the distances represented on the map at the current zoom level.
+
+
+Example
+-------
+
+
+.. jupyter-execute::
+
+
+   from ipyopenlayers import Map, ScaleLine
+
+
+   # Create a map with initial zoom level and center coordinates
+   m = Map(center=[0, 0], zoom=2)
+
+
+   # Add a ScalelineControl to the map
+   scaleline_control = ScaleLine()
+   m.add_control(scaleline_control)
+
+
+   # Display the map
+   m
+
+
+
+
+Attributes
+----------
+
+
+.. autoclass:: ipyopenlayers.openlayers.ScaleLine
+  :members:

docs/source/controls/scaleline_control.rst

@@ -0,0 +1,39 @@
+Zoom Slider Control
+===================
+
+
+The Zoom Slider Control in `ipyopenlayers` provides a convenient slider interface for users to control the zoom level of the map.
+This control enhances the user experience by allowing a more intuitive and precise adjustment of the zoom level.
+
+
+Example
+-------
+
+
+.. jupyter-execute::
+
+
+   from ipyopenlayers import Map, ZoomSlider
+
+
+   # Create a map with initial zoom level and center coordinates
+   m = Map(center=[0, 0], zoom=2)
+
+
+   # Add a ZoomSlider control to the map
+   zoom_slider = ZoomSlider()
+   m.add_control(zoom_slider)
+
+
+   # Display the map
+   m
+
+
+
+
+Attributes
+----------
+
+
+.. autoclass:: ipyopenlayers.openlayers.ZoomSlider
+  :members:

docs/source/controls/zoomslider_control.rst

@@ -1,3 +1,3 @@
 {
-  "path": "../../../examples/introduction.ipynb"
+  "path": "../../../examples/RasterLayer.ipynb"
 }

docs/source/examples/introduction.nblink

@@ -1,4 +1,3 @@
-
 ipyopenlayers
 =====================================
 
@@ -12,38 +11,61 @@ Quickstart
 
 To get started with ipyopenlayers, install with pip::
 
-    pip install ipyopenlayers
+   pip install ipyopenlayers
+
+Contents
+--------
 
-or with conda::
+.. toctree::
+  :maxdepth: 2
+  :caption: Installation and usage
 
-    conda install ipyopenlayers
+  introduction
+  installing
+  develop-install
 
+.. toctree::
+  :maxdepth: 2
+  :caption: Map
+
+  map/index
 
-Contents
---------
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Installation and usage
+  :maxdepth: 2
+  :caption: Layers and Overlays
 
-   installing
-   introduction
+  layers/index
+  overlay/index
 
 .. toctree::
-   :maxdepth: 1
+  :maxdepth: 2
+  :caption: Controls
+
 
-   examples/index
+  controls/index
+
+.. toctree::
+  :maxdepth: 2
+  :caption: API
 
+  api_reference/index
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Development
+  :maxdepth: 1
 
-   develop-install
 
+  examples/index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
 
 .. links
 
 .. _`Jupyter widgets`: https://jupyter.org/widgets.html
-
-.. _`notebook`: https://jupyter-notebook.readthedocs.io/en/latest/
+.. _`notebook`: https://jupyter-notebook.readthedocs.io/en/latest/

docs/source/index.rst

@@ -1,35 +1,33 @@
-
 .. _installation:
 
 Installation
 ============
 
+Installing using pip
+----------------------------------
 
 The simplest way to install ipyopenlayers is via pip::
 
     pip install ipyopenlayers
 
-or via conda::
-
-    conda install ipyopenlayers
-
+Installing the Front-end Extension
+----------------------------------
 
 If you installed via pip, and notebook version < 5.3, you will also have to
 install / configure the front-end extension as well. If you are using classic
 notebook (as opposed to Jupyterlab), run::
 
     jupyter nbextension install [--sys-prefix / --user / --system] --py ipyopenlayers
-
     jupyter nbextension enable [--sys-prefix / --user / --system] --py ipyopenlayers
 
-with the `appropriate flag`_. If you are using Jupyterlab, install the extension
-with::
+with the `appropriate flag`_.
 
-    jupyter labextension install ipyopenlayers
+Installing for JupyterLab
+-------------------------
+
+If you are using JupyterLab, install the extension with::
 
-If you are installing using conda, these commands should be unnecessary, but If
-you need to run them the commands should be the same (just make sure you choose the
-`--sys-prefix` flag).
+    jupyter labextension install ipyopenlayers
 
 
 .. links

docs/source/installing.rst

@@ -2,6 +2,11 @@
 Introduction
 =============
 
-.. todo::
+ipyopenlayers is a Jupyter widget for OpenLayers, a robust open-source JavaScript library for interactive mapping. This integration significantly enhances the capability to visualize GIS data, particularly enabling dynamic and real-time analysis of spatial information. By bringing OpenLayers' advanced mapping features into the Jupyter environment, ipyopenlayers empowers engineers, scientists, and analysts to perform spatial data exploration and analysis more efficiently and effectively.
 
-    add prose explaining project purpose and usage here
+Every object in ipyopenlayers (including the Map, TileLayers, Layers, Controls, etc.) is interactive, allowing users to dynamically update attributes from Python or directly from the browser. This interactivity makes ipyopenlayers a powerful tool for creating sophisticated and responsive GIS applications within Jupyter notebooks.
+
+Try it online
+-------------
+
+You can try ipyopenlayers below, or open many other live examples in a new browser tab with : JupyterLite or RetroLite.