Skip to content

Commit 55c33b6

Browse files
Add a small introduction text/displace text from usage to this introduction/ add a gif.
1 parent 3437521 commit 55c33b6

File tree

4 files changed

+45
-17
lines changed

4 files changed

+45
-17
lines changed

docs/source/_static/gallery.gif

4.59 MB
Loading

docs/source/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
ipyleaflet: Interactive maps in the Jupyter notebook
2-
====================================================
1+
Introduction
2+
============
3+
Ipyleaflet is a Jupyter / Leaflet bridge enabling interactive maps in the Jupyter notebook. It is an interactive widgets library, based on ipywidgets. This means that everything in ipyleaflet (e.g. the Map, TileLayers, Layers, Controls…) is interactive: you can dynamically update attributes from Python or from the Notebook interface.
34

5+
.. image:: _static/gallery.gif
6+
:width: 1200
47

58
Try it online
69
-------------

docs/source/usage/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33
Usage
44
=====
55

6-
ipyleaflet is an interactive widgets library, it is based on `ipywidgets <https://github.com/jupyter-widgets/ipywidgets/>`_.
7-
This means that everything in ipyleaflet (e.g. the ``Map``, ``TileLayers``, ``Markers``...) is interactive: you can dynamically update
8-
attributes from Python or from the Notebook interface.
9-
10-
For example, you can create a ``Marker`` layer and interact with it:
6+
In the following example, a ``Marker`` layer is created and one interacts with it:
117

128
.. code::
139

examples/BaseMap.ipynb

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "code",
5-
"execution_count": null,
5+
"execution_count": 1,
66
"metadata": {},
77
"outputs": [],
88
"source": [
@@ -11,19 +11,48 @@
1111
},
1212
{
1313
"cell_type": "code",
14-
"execution_count": null,
14+
"execution_count": 2,
1515
"metadata": {},
16-
"outputs": [],
16+
"outputs": [
17+
{
18+
"data": {
19+
"application/vnd.jupyter.widget-view+json": {
20+
"model_id": "2395000484b445ca8a84934119bd192f",
21+
"version_major": 2,
22+
"version_minor": 0
23+
},
24+
"text/plain": [
25+
"Map(center=[52, 10], controls=(ZoomControl(options=['position', 'zoom_in_text', 'zoom_in_title', 'zoom_out_tex…"
26+
]
27+
},
28+
"metadata": {},
29+
"output_type": "display_data"
30+
}
31+
],
1732
"source": [
18-
"m = Map(center=(52, 10), zoom=8, basemap=basemaps.OpenStreetMap.Mapnik)\n",
19-
"m"
33+
"m = Map(center=(52, 10), zoom=8, basemap=basemaps.OpenStreetMap.Mapnik)"
2034
]
2135
},
2236
{
2337
"cell_type": "code",
24-
"execution_count": null,
38+
"execution_count": 3,
2539
"metadata": {},
26-
"outputs": [],
40+
"outputs": [
41+
{
42+
"data": {
43+
"application/vnd.jupyter.widget-view+json": {
44+
"model_id": "2395000484b445ca8a84934119bd192f",
45+
"version_major": 2,
46+
"version_minor": 0
47+
},
48+
"text/plain": [
49+
"Map(bottom=21848.0, center=[52, 10], controls=(ZoomControl(options=['position', 'zoom_in_text', 'zoom_in_title…"
50+
]
51+
},
52+
"metadata": {},
53+
"output_type": "display_data"
54+
}
55+
],
2756
"source": [
2857
"strava_all = basemap_to_tiles(basemaps.Strava.All)\n",
2958
"m.add(strava_all)"
@@ -108,7 +137,7 @@
108137
],
109138
"metadata": {
110139
"kernelspec": {
111-
"display_name": "Python 3",
140+
"display_name": "Python 3 (ipykernel)",
112141
"language": "python",
113142
"name": "python3"
114143
},
@@ -122,9 +151,9 @@
122151
"name": "python",
123152
"nbconvert_exporter": "python",
124153
"pygments_lexer": "ipython3",
125-
"version": "3.7.4"
154+
"version": "3.9.13"
126155
}
127156
},
128157
"nbformat": 4,
129-
"nbformat_minor": 2
158+
"nbformat_minor": 4
130159
}

0 commit comments

Comments
 (0)