Skip to content

Commit cfb6044

Browse files
author
Martin Journois
committed
Complete doc structure
1 parent 337b2ff commit cfb6044

11 files changed

Lines changed: 231 additions & 60 deletions

File tree

‎docs/contributing.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Contributing
2+
============
3+
14
Choose the sandbox folder of your choice (`~/sandbox` for example)
25
::
36

@@ -10,4 +13,4 @@ $ git clone https://github.com/python-visualization/folium
1013

1114
Push code to your fors, and write a pull request.
1215

13-
TODO: end up this section.
16+
TODO: end up this section.

‎docs/examples.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Examples
2+
========
3+
4+
TODO: document here

‎docs/index.rst‎

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,23 @@ Folium: Python Data. Leaflet.js Maps.
66

77
Folium builds on the data wrangling strengths of the Python ecosystem and the mapping strengths of the Leaflet.js library. Manipulate your data in Python, then visualize it in on a Leaflet map via Folium.
88

9-
.. _concepts:
10-
11-
:ref:`Concepts <concepts>`
12-
*************************
9+
Concepts
10+
========
1311

1412
Folium makes it easy to visualize data that's been manipulated in Python on an interactive Leaflet map. It enables both the binding of data to a map for choropleth visualizations as well as passing Vincent/Vega visualizations as markers on the map.
1513

1614
The library has a number of built-in tilesets from OpenStreetMap, Mapbox, and Stamen, and supports custom tilesets with Mapbox or Cloudmade API keys. Folium supports both GeoJSON and TopoJSON overlays, as well as the binding of data to those overlays to create choropleth maps with color-brewer color schemes.
1715

1816

19-
:doc:`Quickstart </quickstart>`
20-
*******************************
21-
.. toctree::
22-
:maxdepth: 3
23-
24-
quickstart
25-
26-
27-
:doc:`Installing </installing>`
28-
*******************************
17+
Contents
18+
========
2919

3020
.. toctree::
3121
:maxdepth: 3
3222

23+
quickstart
24+
examples
3325
installing
34-
35-
:doc:`Contributing </contributing>`
36-
***********************************
37-
38-
.. toctree::
39-
:maxdepth: 3
40-
4126
contributing
42-
43-
44-
:doc:`Module description </module>`
45-
***********************************
46-
47-
.. toctree::
48-
:maxdepth: 3
49-
5027
module
5128

‎docs/installing.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
Installing
2+
==========
13

24
Requirements
35
------------

‎docs/module.rst‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,52 @@
1+
.. _module::
2+
ModuleDescription
3+
*****************
4+
15
:doc:`Element </module/element>`
2-
=========================
6+
================================
37

48
.. toctree::
59
:maxdepth: 3
610

711
module/element
812

913
:doc:`Map </module/map>`
10-
=========================
14+
========================
1115

1216
.. toctree::
1317
:maxdepth: 3
1418

1519
module/map
20+
21+
:doc:`Features </module/features>`
22+
==================================
23+
24+
.. toctree::
25+
:maxdepth: 3
26+
27+
module/features
28+
29+
:doc:`Folium </module/folium>`
30+
==============================
31+
32+
.. toctree::
33+
:maxdepth: 3
34+
35+
module/folium
36+
37+
:doc:`Colormap </module/colormap>`
38+
==================================
39+
40+
.. toctree::
41+
:maxdepth: 3
42+
43+
module/colormap
44+
45+
:doc:`Utilities </module/utilities>`
46+
====================================
47+
48+
.. toctree::
49+
:maxdepth: 3
50+
51+
module/utilities
52+

‎docs/module/colormap.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
`ColorMap`
2+
----------
3+
4+
.. autoclass:: folium.colormap.ColorMap
5+
:members:
6+
7+
`LinearColormap`
8+
----------------
9+
10+
.. autoclass:: folium.colormap.LinearColormap
11+
:members:
12+
13+
`StepColormap`
14+
--------------
15+
16+
.. autoclass:: folium.colormap.StepColormap
17+
:members:
18+
19+
`linear`
20+
--------
21+
22+
.. autodata:: folium.colormap.linear
23+
:annotation:
24+

‎docs/module/features.rst‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
`WmsTileLayer`
2+
--------------
3+
4+
.. autoclass:: folium.features.WmsTileLayer
5+
:members:
6+
7+
`RegularPolygonMarker`
8+
----------------------
9+
10+
.. autoclass:: folium.features.RegularPolygonMarker
11+
:members:
12+
13+
`Vega`
14+
------
15+
16+
.. autoclass:: folium.features.Vega
17+
:members:
18+
19+
`GeoJson`
20+
---------
21+
22+
.. autoclass:: folium.features.GeoJson
23+
:members:
24+
25+
`TopoJson`
26+
----------
27+
28+
.. autoclass:: folium.features.TopoJson
29+
:members:
30+
31+
`MarkerCluster`
32+
---------------
33+
34+
.. autoclass:: folium.features.MarkerCluster
35+
:members:
36+
37+
`DivIcon`
38+
---------
39+
40+
.. autoclass:: folium.features.DivIcon
41+
:members:
42+
43+
`CircleMarker`
44+
--------------
45+
46+
.. autoclass:: folium.features.CircleMarker
47+
:members:
48+
49+
`LatLngPopup`
50+
-------------
51+
52+
.. autoclass:: folium.features.LatLngPopup
53+
:members:
54+
55+
`ClickForMarker`
56+
----------------
57+
58+
.. autoclass:: folium.features.ClickForMarker
59+
:members:
60+
61+
`PolyLine`
62+
----------
63+
64+
.. autoclass:: folium.features.PolyLine
65+
:members:
66+
67+
`MultiPolyLine`
68+
---------------
69+
70+
.. autoclass:: folium.features.MultiPolyLine
71+
:members:
72+
73+
`CustomIcon`
74+
------------
75+
76+
.. autoclass:: folium.features.CustomIcon
77+
:members:
78+

‎docs/module/folium.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
`Map`
2+
-----
3+
4+
.. autoclass:: folium.folium.Map
5+
:members:
6+

‎docs/module/map.rst‎

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,54 @@
1-
`Element`
2-
---------
1+
`LegacyMap`
2+
-----------
33

4-
.. autoclass:: folium.element.Element
4+
.. autoclass:: folium.map.LegacyMap
55
:members:
66

7-
`MacroElement`
8-
--------------
7+
`Layer`
8+
-------
99

10-
.. autoclass:: folium.element.MacroElement
10+
.. autoclass:: folium.map.Layer
1111
:members:
1212

13-
`Figure`
14-
--------
13+
`TileLayer`
14+
-----------
1515

16-
.. autoclass:: folium.element.Figure
16+
.. autoclass:: folium.map.TileLayer
1717
:members:
1818

19-
`Html`
20-
------
19+
`FeatureGroup`
20+
--------------
2121

22-
.. autoclass:: folium.element.Html
22+
.. autoclass:: folium.map.FeatureGroup
2323
:members:
2424

25-
`Div`
26-
-----
25+
`LayerControl`
26+
--------------
2727

28-
.. autoclass:: folium.element.Div
28+
.. autoclass:: folium.map.LayerControl
2929
:members:
3030

31-
`IFrame`
32-
--------
31+
`Icon`
32+
------
3333

34-
.. autoclass:: folium.element.IFrame
34+
.. autoclass:: folium.map.Icon
3535
:members:
3636

37-
`Link`
38-
------
37+
`Marker`
38+
--------
3939

40-
.. autoclass:: folium.element.Link
40+
.. autoclass:: folium.map.Marker
4141
:members:
4242

43-
`JavascriptLink`
44-
----------------
43+
`Popup`
44+
-------
4545

46-
.. autoclass:: folium.element.JavascriptLink
46+
.. autoclass:: folium.map.Popup
4747
:members:
4848

49-
`CssLink`
50-
---------
49+
`FitBounds`
50+
-----------
5151

52-
.. autoclass:: folium.element.CssLink
52+
.. autoclass:: folium.map.FitBounds
5353
:members:
54+

‎docs/module/utilities.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
`legend_scaler`
2+
---------------
3+
4+
.. autofunction:: folium.utilities.legend_scaler
5+
6+
7+
`linear_gradient`
8+
-----------------
9+
10+
.. autofunction:: folium.utilities.linear_gradient
11+
12+
13+
`color_brewer`
14+
--------------
15+
16+
.. autofunction:: folium.utilities.color_brewer
17+
18+
`split_six`
19+
-----------
20+
21+
.. autofunction:: folium.utilities.split_six
22+
23+
`image_to_url`
24+
--------------
25+
26+
.. autofunction:: folium.utilities.image_to_url
27+
28+
`write_png`
29+
-----------
30+
31+
.. autofunction:: folium.utilities.write_png
32+
33+
34+
`_parse_size`
35+
-------------
36+
37+
.. autofunction:: folium.utilities._parse_size
38+
39+

0 commit comments

Comments
 (0)