Skip to content

Commit c61d420

Browse files
committed
user guide and advanced guide scaffolding
1 parent e0a7061 commit c61d420

7 files changed

Lines changed: 339 additions & 59 deletions

File tree

docs/advanced_guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Advanced guide
2+
==============
Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,36 @@
1-
Quickstart
1+
Getting started
22
===============
33

4+
Installation
5+
------------
6+
7+
Folium can be installed using
8+
9+
```
10+
$ pip install folium
11+
```
12+
13+
If you are using the Conda package manager, the equivalent is
14+
15+
```
16+
$ conda install folium -c conda-forge
17+
```
18+
19+
20+
### Dependencies
21+
22+
Folium has the following dependencies, all of which are installed automatically
23+
with the above installation commands:
24+
25+
- branca
26+
- Jinja2
27+
- Numpy
28+
- Requests
29+
30+
Additional packages may be necessary for some functionality. It will say so in
31+
the documentation where that's the case.
32+
33+
434
Creating a map
535
---------------
636

docs/getting_started.rst

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

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Mapbox, and Stamen, and supports custom tilesets with Mapbox or Cloudmade API ke
2929

3030
Home <self>
3131
Getting started <getting_started>
32+
User guide <user_guide>
33+
Advanced guide <advanced_guide>
3234
API reference <reference>
3335

3436

docs/user_guide.rst

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,12 @@ User guide
33

44
The user guide covers different parts of basic usage of Folium. Each page focuses on a single topic and outlines how it is implemented in Folium, with reproducible examples.
55

6-
If you don't know anything about Folium, start with the :doc:`Introduction to GeoPandas <../getting_started/introduction>`.
6+
If you don't know anything about Folium, start with the :doc:`Quickstart <../getting_started/quickstart>`.
77

88
Advanced topics can be found in the :doc:`Advanced Guide <advanced_guide>` and further specification in the :doc:`API Reference <reference>`.
99

1010
.. toctree::
1111
:maxdepth: 2
1212

13-
Data structures <user_guide/data_structures>
14-
Reading and writing files <user_guide/io>
15-
Indexing and selecting data <user_guide/indexing>
16-
Making maps and plots <user_guide/mapping>
17-
Interactive mapping <user_guide/interactive_mapping>
18-
Projections <user_guide/projections>
19-
Geometric manipulations <user_guide/geometric_manipulations>
20-
Set operations with overlay <user_guide/set_operations>
21-
Aggregation with dissolve <user_guide/aggregation_with_dissolve>
22-
Merging data <user_guide/mergingdata>
23-
Geocoding <user_guide/geocoding>
24-
Sampling points <user_guide/sampling>
13+
Features <user_guide/features>
14+
Plugins <user_guide/plugins>

0 commit comments

Comments
 (0)