Updates on ipyleaflet documentation

use autodoc to replace the attributes and methods tables of the documentation by the autogeneration using docstrings write the docstrings of velocity.Velocity class add a page named API reference page for the leaflet module add changes to homogenize the structure/names of the sections of the different pages
jupyter-widgets · Apr 1, 2022 · e5d406d · e5d406d
1 parent 235f7e8
commit e5d406d
Show file tree

Hide file tree

Showing 42 changed files with 253 additions and 512 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,3 +6,5 @@ geopandas
 xarray
 branca
 shapely
+.
+pydata-sphinx-theme
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,5 @@
+API Reference
+----------
+
+.. automodule:: ipyleaflet.leaflet
+   :members:
diff --git a/docs/source/api_reference/antpath.rst b/docs/source/api_reference/antpath.rst
@@ -55,17 +55,5 @@ Like most widgets in ipyleaflet, the ``AntPath`` can be dynamically updated from
 Attributes
 ----------
 
-=====================    =====================   ===
-Attribute                Default Value           Doc
-=====================    =====================   ===
-locations                []                      List of path points as (lat, lng) couples
-color                    '#0000FF'               Background color for the path
-pulse_color              '#FFFFFF'               Color of the moving ants on the path
-paused                   False                   Whether the ants are moving or not
-reverse                  False                   Whether the ants are moving in reverse or not
-use                      'polyline'              Which shape is drawn, possible values are 'polyline', 'polygon', 'rectangle' and 'circle'
-dash_array               [10, 20]                Dash pattern for lines as a list of non-negative numbers
-weight                   5                       Lines weight
-delay                    400                     Ants speed
-radius                   10                      Radius of the circle, if ``use`` is set to 'circle'
-=====================    =====================   ===
+.. autoclass:: ipyleaflet.leaflet.AntPath
+   :members:
diff --git a/docs/source/api_reference/awesome_icon.rst b/docs/source/api_reference/awesome_icon.rst
@@ -54,11 +54,5 @@ Unlike other widgets in ipyleaflet, the ``AwesomeIcon`` widget is not dynamic. I
 Attributes
 ----------
 
-=====================    =====================   ===
-Attribute                Default Value           Doc
-=====================    =====================   ===
-name                     'home'                  Name of the Font-Awesome icon
-marker_color             'blue'                  Marker background color
-icon_color               'white'                 Icon color
-spin                     False                   Whether the icon is spinning or not
-=====================    =====================   ===
+.. autoclass:: ipyleaflet.leaflet.AwesomeIcon
+   :members:
diff --git a/docs/source/api_reference/choropleth.rst b/docs/source/api_reference/choropleth.rst
@@ -91,16 +91,5 @@ The ``Choropleth`` layer is then created specifying on which key the colormap is
 Attributes
 ----------
 
-==============   ==========================  ===========
-Attribute        Default                     Doc
-==============   ==========================  ===========
-geo_data         {}                          Data dictionary
-choro_data       {}                          Mapping key -> float data for constructing the colormap
-key_on           'id'                        Key used for the colormap construction
-value_min                                    Color scale minimum value
-value_max                                    Color scale maximum value
-colormap         OrRd_06                     Map of color from branca
-style                                        Style dictionary
-hover_style                                  Hover style dictionary
-style_callback                               Styling function that is called for each feature, and should return the feature style. This styling function takes the feature, the colormap function and the key data as arguments.
-==============   ==========================  ===========
+.. autoclass:: ipyleaflet.leaflet.Choropleth
+   :members:
diff --git a/docs/source/api_reference/circle.rst b/docs/source/api_reference/circle.rst
@@ -26,19 +26,5 @@ Example
 Attributes
 ----------
 
-==============    ================   ===
-Attribute         Default Value      Doc
-==============    ================   ===
-location          (0.0, 0.0)         Circle location
-radius            10                 Circle radius in meters
-stroke            True               Set it to `false` to disable borders
-color             "#0033FF"          Stroke color
-opacity           1.0                Stroke opacity
-weight            5                  Stroke width in pixels
-fill              True               Whether to fill the circle or not
-fill_color        None
-fill_opacity      0.2
-dash_array
-line_cap          "round"
-line_join         "round"
-==============    ================   ===
+.. autoclass:: ipyleaflet.leaflet.Circle
+   :members:
diff --git a/docs/source/api_reference/circle_marker.rst b/docs/source/api_reference/circle_marker.rst
@@ -26,19 +26,5 @@ Example
 Attributes
 ----------
 
-==============    ================   ===
-Attribute         Default Value      Doc
-==============    ================   ===
-location          (0.0, 0.0)         Circle location
-radius            10                 Circle radius in pixels
-stroke            True               Set it to `false` to disable borders
-color             "#0033FF"          Stroke color
-opacity           1.0                Stroke opacity
-weight            5                  Stroke width in pixels
-fill              True               Whether to fill the circle or not
-fill_color        None
-fill_opacity      0.2
-dash_array
-line_cap          "round"
-line_join         "round"
-==============    ================   ===
+.. autoclass:: ipyleaflet.leaflet.CircleMarker
+   :members:
diff --git a/docs/source/api_reference/divicon.rst b/docs/source/api_reference/divicon.rst
@@ -21,12 +21,5 @@ Example
 Attributes
 ----------
 
-=====================    =====================   ===
-Attribute                Default Value           Doc
-=====================    =====================   ===
-html                     ''                      Custom HTML code to put inside the div element,
-bg_pos                   (0, 0)                  Optional relative position of the background, in pixels.
-icon_size                (10, 10)                size icon will be rendered
-icon_anchor              (0, 0)                  anchor point of icon
-popup_anchor             (0, 0)                  anchor point of popup
-=====================    =====================   ===
+.. autoclass:: ipyleaflet.leaflet.DivIcon
+   :members:
diff --git a/docs/source/api_reference/draw_control.rst b/docs/source/api_reference/draw_control.rst
@@ -3,6 +3,8 @@ Draw Control
 
 The ``DrawControl`` allows one to draw shapes on the map such as ``Rectangle`` ``Circle`` or lines.
 
+Example
+-------
 .. jupyter-execute::
 
     from ipyleaflet import Map, basemaps, basemap_to_tiles, DrawControl

diff --git a/docs/source/api_reference/fullscreen_control.rst b/docs/source/api_reference/fullscreen_control.rst
@@ -13,9 +13,8 @@ Example
 
     m
 
+Attribute
+-------
 
-================    ================   ===
-Attribute           Default Value      Doc
-================    ================   ===
-position            'topleft'          Position of the control, can be 'bottomleft', 'bottomright', 'topleft', or 'topright'
-================    ================   ===
+.. autoclass:: ipyleaflet.leaflet.FullScreenControl
+   :members:
diff --git a/docs/source/api_reference/geo_json.rst b/docs/source/api_reference/geo_json.rst
@@ -56,24 +56,9 @@ The ``GeoJSON`` layer is a widget, which means that you can update the ``data``
     geo_json.hover_style = new_hover_style
 
 
-Attributes
+Attributes and methods
 ----------
 
-==============   ===
-Attribute        Doc
-==============   ===
-data             Data dictionary
-style            Style dictionary
-hover_style      Hover style dictionary
-style_callback   Styling function that is called for each feature, and should return the feature style. This styling function takes the feature as argument.
-==============   ===
+.. autoclass:: ipyleaflet.leaflet.GeoJSON
+   :members:
 
-Methods
--------
-
-=========    =====================================     ===
-Method       Arguments                                 Doc
-=========    =====================================     ===
-on_click     Callable object                           Adds a callback on click event
-on_hover     Callable object                           Adds a callback on hover event
-=========    =====================================     ===
diff --git a/docs/source/api_reference/geodata.rst b/docs/source/api_reference/geodata.rst
@@ -62,11 +62,5 @@ Points example:
 Attributes
 ----------
 
-============   ==========================  ===========
-Attribute      Doc                         Description
-============   ==========================  ===========
-geo_data       Data dictionary             GeoDataFrame
-style          Style dictionary
-hover_style    Hover style dictionary
-point_style    Point decorations           Used to represent point data on the map as CircleMarkers.  If absent, points will be represented by Markers.
-============   ==========================  ===========
+.. autoclass:: ipyleaflet.leaflet.GeoData
+   :members:
diff --git a/docs/source/api_reference/heatmap.rst b/docs/source/api_reference/heatmap.rst
@@ -23,15 +23,6 @@ Example
 Attributes
 ----------
 
-==============    ===================================================================    ====
-Attribute         Default Value                                                          Doc
-==============    ===================================================================    ====
-locations         []                                                                     List of center locations
-min_opacity       0.05                                                                   Minimum opacity the heat will start at
-max_zoom          18                                                                     Zoom level where max intensity is reached
-max               1.0                                                                    Maximum point intensity
-radius            25.0                                                                   Radius of each "point" of the heatmap
-blur              15.0                                                                   Amount of blur
-gradient          {0.4: 'blue', 0.6: 'cyan', 0.7: 'lime', 0.8: 'yellow', 1.0: 'red'}     Color gradient config
-==============    ===================================================================    ====
+.. autoclass:: ipyleaflet.leaflet.Heatmap
+   :members:
 
diff --git a/docs/source/api_reference/icon.rst b/docs/source/api_reference/icon.rst
@@ -21,14 +21,5 @@ Example
 Attributes
 ----------
 
-=====================    =====================   ===
-Attribute                Default Value           Doc
-=====================    =====================   ===
-icon_url                 ''                      url for icon
-shadow_url               None                    url for icon shadow
-icon_size                (10, 10)                size icon will be rendered
-shadow_size              (10, 10)                size icon shadow will be rendered
-icon_anchor              (0, 0)                  anchor point of icon
-shadow_anchor            (0, 0)                  anchor point of shadow
-popup_anchor             (0, 0)                  anchor point of popup
-=====================    =====================   ===
+.. autoclass:: ipyleaflet.leaflet.Icon
+   :members:
diff --git a/docs/source/api_reference/image_video_overlay.rst b/docs/source/api_reference/image_video_overlay.rst
@@ -41,9 +41,5 @@ Example VideoOverlay
 Attributes
 ----------
 
-===========    ========================   ===
-Attribute      Default Value              Doc
-===========    ========================   ===
-url            ""                         An http url to the footage or a relative path to a local file (image/video). Note that absolute local paths are not supported. 
-bounds         ((0.0, 0.0), (0.0, 0.0))   SW and NE corners of the image
-===========    ========================   ===
+.. autoclass:: ipyleaflet.leaflet.VideoOverlay
+   :members:
diff --git a/docs/source/api_reference/layer_group.rst b/docs/source/api_reference/layer_group.rst
@@ -35,19 +35,5 @@ Example
 Attributes
 ----------
 
-==============    ================   ===
-Attribute         Default Value      Doc
-==============    ================   ===
-layers            ()                 List of layers
-==============    ================   ===
-
-Methods
--------
-
-==============    =====================================     ===
-Method            Arguments                                 Doc
-==============    =====================================     ===
-add_layer         Layer instance                            Add a new layer to the group
-remove_layer      Layer instance                            Remove a layer from the group
-clear_layers                                                Remove all layers from the group
-==============    =====================================     ===
+.. autoclass:: ipyleaflet.leaflet.LayerGroup
+   :members:
diff --git a/docs/source/api_reference/layers_control.rst b/docs/source/api_reference/layers_control.rst
@@ -1,12 +1,17 @@
 Layers Control
 ==============
 
+
+
 The ``LayersControl`` allows one to display a layer selector on the map in order
 to select which layers to display on the map.
 
 All layers have a ``name`` attribute which is displayed in the selector and can be changed
 by the user.
 
+Example
+-------
+
 .. jupyter-execute::
 
     from ipyleaflet import Map, Marker, LayersControl
@@ -24,3 +29,4 @@ by the user.
     m.add_control(control)
 
     m
+
diff --git a/docs/source/api_reference/legend_control.rst b/docs/source/api_reference/legend_control.rst
@@ -37,10 +37,5 @@ Example
 Attributes
 ----------
 
-================    ================   ===
-Attribute           Default Value      Doc
-================    ================   ===
-position            'topleft'          Position of the control, can be 'bottomleft', 'bottomright', 'topleft', or 'topright'
-legend              None               A dictionary containing the name->color mapping that represents the legend
-title               'Legend'           Legend name
-================    ================   ===
+.. autoclass:: ipyleaflet.leaflet.LegendControl
+   :members:
diff --git a/docs/source/api_reference/local_tile_layer.rst b/docs/source/api_reference/local_tile_layer.rst
@@ -22,8 +22,5 @@ In JupyterLab, the path is relative to the server (where you started JupyterLab)
 Attributes
 ----------
 
-===============    =================  =====
-Attribute          Default Value      Doc
-===============    =================  =====
-path               ""                 Relative URL (e.g. 'tiles/{z}/{x}/{y}.png' or 'files/tiles/{z}/{x}/{y}.png' in JupyterLab)
-===============    =================  =====
+.. autoclass:: ipyleaflet.leaflet.LocalTileLayer
+   :members:
diff --git a/docs/source/api_reference/magnifying_glass.rst b/docs/source/api_reference/magnifying_glass.rst
@@ -20,13 +20,5 @@ Example
 Attributes
 ----------
 
-==============    ===================================================================    ====
-Attribute         Default Value                                                          Doc
-==============    ===================================================================    ====
-radius            100                                                                    Radius of the magnifying glass in pixels.
-zoom_offset       3                                                                      Zoom level offset between the main map zoom and the magnifying glass.
-fixed_zoom        -1                                                                     Fixed zoom level to always use (if different than -1).
-fixed_position    False                                                                  If True, the magnifying glass will stay at the same position.
-lat_lng           [0, 0]                                                                 Initial position of the magnifying glass.
-layers            []                                                                     Set of layers to display in the magnified view.
-==============    ===================================================================    ====
+.. autoclass:: ipyleaflet.leaflet.MagnifyingGlass
+   :members:
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,3 +6,5 @@ geopandas @@
     xarray
     branca
     shapely
+    .
+    pydata-sphinx-theme