Skip to content

Commit e0a7061

Browse files
committed
better organization
1 parent d4775c6 commit e0a7061

6 files changed

Lines changed: 66 additions & 42 deletions

File tree

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
1+
Getting started
2+
===============
3+
4+
.. toctree::
5+
:hidden:
6+
7+
Quickstart <getting_started/quickstart.md>
8+
9+
10+
111
Installation
2-
============
12+
------------
13+
314
Folium can be installed using
415

516
::
@@ -14,7 +25,7 @@ $ conda install folium -c conda-forge
1425

1526

1627
Dependencies
17-
============
28+
^^^^^^^^^^^^
1829

1930
Folium has the following dependencies, all of which are installed automatically
2031
with the above installation commands:
@@ -26,3 +37,9 @@ with the above installation commands:
2637

2738
Additional packages may be necessary for some functionality. It will say so in
2839
the documentation where that's the case.
40+
41+
42+
What's next
43+
-----------
44+
45+
Check out the :doc:`Quickstart <getting_started/quickstart>`
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
Quickstart
2-
==========
3-
4-
Folium is a geographical visualization library for Python, based on
5-
[Leaflet.js](https://leafletjs.com/).
6-
2+
===============
73

84
Creating a map
95
---------------

docs/index.rst

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Folium
55

66
.. image:: _static/folium_logo.jpg
77

8-
Python data, leaflet.js maps
9-
****************************
8+
**Python data, leaflet.js maps**
109

1110
``folium`` builds on the data wrangling strengths of the Python ecosystem and
1211
the mapping strengths of the ``leaflet.js`` library.
@@ -25,29 +24,13 @@ Mapbox, and Stamen, and supports custom tilesets with Mapbox or Cloudmade API ke
2524
``folium`` supports both Image, Video, GeoJSON and TopoJSON overlays.
2625

2726

28-
Contents
29-
==================================
30-
3127
.. toctree::
32-
:maxdepth: 1
33-
:caption: Getting Started
34-
35-
installing
36-
quickstart.md
28+
:hidden:
3729

30+
Home <self>
31+
Getting started <getting_started>
32+
API reference <reference>
3833

39-
.. toctree::
40-
:maxdepth: 1
41-
:caption: User guide
42-
43-
flask
44-
45-
.. toctree::
46-
:maxdepth: 1
47-
:caption: API reference
48-
49-
modules
50-
plugins
5134

5235

5336
Indices and tables

docs/plugins.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
1-
:mod:`folium`
2-
-------------
1+
API reference
2+
=============
3+
4+
Map
5+
--------------------
36

47
.. automodule:: folium.folium
58

69

7-
:mod:`map`
8-
----------
10+
UI elements
11+
--------------------
912

1013
.. automodule:: folium.map
1114

1215

13-
:mod:`Vector Layers`
16+
Raster Layers
1417
--------------------
1518

16-
.. automodule:: folium.vector_layers
19+
.. automodule:: folium.raster_layers
1720

1821

19-
:mod:`Raster Layers`
22+
Vector Layers
2023
--------------------
2124

22-
.. automodule:: folium.raster_layers
25+
.. automodule:: folium.vector_layers
2326

2427

25-
:mod:`Extra Features`
28+
Other map features
2629
---------------------
2730

2831
.. automodule:: folium.features
32+
33+
34+
Plugins
35+
--------------------
36+
.. automodule:: folium.plugins

docs/user_guide.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
User guide
2+
==========
3+
4+
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.
5+
6+
If you don't know anything about Folium, start with the :doc:`Introduction to GeoPandas <../getting_started/introduction>`.
7+
8+
Advanced topics can be found in the :doc:`Advanced Guide <advanced_guide>` and further specification in the :doc:`API Reference <reference>`.
9+
10+
.. toctree::
11+
:maxdepth: 2
12+
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>

0 commit comments

Comments
 (0)