Skip to content

Commit a807003

Browse files
committed
Getting Started
1 parent 7490c2a commit a807003

File tree

4 files changed

+59
-18
lines changed

4 files changed

+59
-18
lines changed

docs/index.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,23 @@ Contents
2929
==================================
3030

3131
.. toctree::
32-
:maxdepth: 3
33-
:caption: Contents:
32+
:maxdepth: 1
33+
:caption: Getting Started
3434

3535
installing
36+
overview
37+
38+
.. toctree::
39+
:maxdepth: 1
40+
:caption: Contents
41+
3642
Quickstart.md
3743
flask
44+
45+
.. toctree::
46+
:maxdepth: 1
47+
:caption: API reference
48+
3849
modules
3950
plugins
4051

docs/installing.rst

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,29 @@
1-
Installing
2-
==========
1+
Installation
2+
============
3+
Folium can be installed using
34

4-
Requirements
5-
------------
65
::
76

8-
branca, jinja2 and requests.
9-
10-
Some functionalities may require extra dependencies
11-
`numpy`, `pandas`, `geopandas`, `altair`, etc.
7+
$ pip install folium
128

9+
If you are using the Conda package manager, the equivalent is
1310

14-
Installation
15-
------------
1611
::
1712

18-
$ pip install folium
13+
$ conda install folium -c conda-forge
1914

20-
or
2115

22-
::
16+
Dependencies
17+
============
2318

24-
$ conda install folium -c conda-forge
19+
Folium has the following dependencies, all of which are installed automatically
20+
with the above installation commands:
21+
22+
- python 3.6 or newer
23+
- branca
24+
- Jinja2
25+
- Numpy
26+
- Requests
27+
28+
Additional packages may be necessary for some functionality. It will say so in
29+
the documentation where that's the case.

docs/overview.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Overview
2+
==========
3+
4+
Folium is a geographical visualization library for Python, based on
5+
[Leaflet.js](https://leafletjs.com/).
6+
7+
Here's a basic example of creating a map:
8+
9+
```{code-cell} ipython3
10+
import folium
11+
12+
m = folium.Map(location=[45.5236, -122.6750])
13+
```
14+
15+
If you are in a Jupyter Notebook, you can display it like this:
16+
17+
```{code-cell} ipython3
18+
m
19+
```
20+
21+
Or you can save it as an HTML file:
22+
23+
```{code-cell} ipython3
24+
m.save("index.html")
25+
```

docs/plugins.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:mod:`plugins`
2-
--------------
1+
Plugins
2+
=======
33

44
.. automodule:: folium.plugins

0 commit comments

Comments
 (0)