Skip to content

Commit a54fbb4

Browse files
martinRenoumartinRenou
authored
Merge pull request #953 from HaudinFlorence/dev
Updates on ipyleaflet documentation
2 parents 235f7e8 + 1b0a040 commit a54fbb4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+272
-520
lines changed

‎.readthedocs.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
version: 2
2+
3+
build:
4+
os: "ubuntu-20.04"
5+
tools:
6+
python: "mambaforge-4.10"
7+
8+
conda:
9+
environment: docs/environment.yml

‎docs/environment.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: ipyleaflet-docs
2+
3+
channels:
4+
- conda-forge
5+
6+
dependencies:
7+
- yarn
8+
- jupyterlab
9+
- jupyter-packaging
10+
- jupyter-sphinx
11+
- scipy
12+
- netcdf4
13+
- geopandas
14+
- xarray
15+
- branca
16+
- shapely
17+
- pip:
18+
- ..
19+
20+

‎docs/requirements.txt

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/source/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
API Reference
2+
----------
3+
4+
.. automodule:: ipyleaflet.leaflet
5+
:members:

‎docs/source/api_reference/antpath.rst

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,5 @@ Like most widgets in ipyleaflet, the ``AntPath`` can be dynamically updated from
5555
Attributes
5656
----------
5757

58-
===================== ===================== ===
59-
Attribute Default Value Doc
60-
===================== ===================== ===
61-
locations [] List of path points as (lat, lng) couples
62-
color '#0000FF' Background color for the path
63-
pulse_color '#FFFFFF' Color of the moving ants on the path
64-
paused False Whether the ants are moving or not
65-
reverse False Whether the ants are moving in reverse or not
66-
use 'polyline' Which shape is drawn, possible values are 'polyline', 'polygon', 'rectangle' and 'circle'
67-
dash_array [10, 20] Dash pattern for lines as a list of non-negative numbers
68-
weight 5 Lines weight
69-
delay 400 Ants speed
70-
radius 10 Radius of the circle, if ``use`` is set to 'circle'
71-
===================== ===================== ===
58+
.. autoclass:: ipyleaflet.leaflet.AntPath
59+
:members:

‎docs/source/api_reference/awesome_icon.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,5 @@ Unlike other widgets in ipyleaflet, the ``AwesomeIcon`` widget is not dynamic. I
5454
Attributes
5555
----------
5656

57-
===================== ===================== ===
58-
Attribute Default Value Doc
59-
===================== ===================== ===
60-
name 'home' Name of the Font-Awesome icon
61-
marker_color 'blue' Marker background color
62-
icon_color 'white' Icon color
63-
spin False Whether the icon is spinning or not
64-
===================== ===================== ===
57+
.. autoclass:: ipyleaflet.leaflet.AwesomeIcon
58+
:members:

‎docs/source/api_reference/choropleth.rst

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -91,16 +91,5 @@ The ``Choropleth`` layer is then created specifying on which key the colormap is
9191
Attributes
9292
----------
9393

94-
============== ========================== ===========
95-
Attribute Default Doc
96-
============== ========================== ===========
97-
geo_data {} Data dictionary
98-
choro_data {} Mapping key -> float data for constructing the colormap
99-
key_on 'id' Key used for the colormap construction
100-
value_min Color scale minimum value
101-
value_max Color scale maximum value
102-
colormap OrRd_06 Map of color from branca
103-
style Style dictionary
104-
hover_style Hover style dictionary
105-
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.
106-
============== ========================== ===========
94+
.. autoclass:: ipyleaflet.leaflet.Choropleth
95+
:members:

‎docs/source/api_reference/circle.rst

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,5 @@ Example
2626
Attributes
2727
----------
2828

29-
============== ================ ===
30-
Attribute Default Value Doc
31-
============== ================ ===
32-
location (0.0, 0.0) Circle location
33-
radius 10 Circle radius in meters
34-
stroke True Set it to `false` to disable borders
35-
color "#0033FF" Stroke color
36-
opacity 1.0 Stroke opacity
37-
weight 5 Stroke width in pixels
38-
fill True Whether to fill the circle or not
39-
fill_color None
40-
fill_opacity 0.2
41-
dash_array
42-
line_cap "round"
43-
line_join "round"
44-
============== ================ ===
29+
.. autoclass:: ipyleaflet.leaflet.Circle
30+
:members:

‎docs/source/api_reference/circle_marker.rst

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,5 @@ Example
2626
Attributes
2727
----------
2828

29-
============== ================ ===
30-
Attribute Default Value Doc
31-
============== ================ ===
32-
location (0.0, 0.0) Circle location
33-
radius 10 Circle radius in pixels
34-
stroke True Set it to `false` to disable borders
35-
color "#0033FF" Stroke color
36-
opacity 1.0 Stroke opacity
37-
weight 5 Stroke width in pixels
38-
fill True Whether to fill the circle or not
39-
fill_color None
40-
fill_opacity 0.2
41-
dash_array
42-
line_cap "round"
43-
line_join "round"
44-
============== ================ ===
29+
.. autoclass:: ipyleaflet.leaflet.CircleMarker
30+
:members:

‎docs/source/api_reference/divicon.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,5 @@ Example
2121
Attributes
2222
----------
2323

24-
===================== ===================== ===
25-
Attribute Default Value Doc
26-
===================== ===================== ===
27-
html '' Custom HTML code to put inside the div element,
28-
bg_pos (0, 0) Optional relative position of the background, in pixels.
29-
icon_size (10, 10) size icon will be rendered
30-
icon_anchor (0, 0) anchor point of icon
31-
popup_anchor (0, 0) anchor point of popup
32-
===================== ===================== ===
24+
.. autoclass:: ipyleaflet.leaflet.DivIcon
25+
:members:

0 commit comments

Comments
 (0)