Skip to content

Commit 57e8eae

Browse files
authored
Docs: folium logo (#1801)
* Use transparent png logo * add logo to docs header * set logo height * set space between logo and header * logo text in header * Simpler index text, link to leaflet * typo
1 parent f572f9e commit 57e8eae

File tree

5 files changed

+18
-12
lines changed

5 files changed

+18
-12
lines changed

README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
folium
2323
======
2424

25-
.. image:: https://github.com/python-visualization/folium/blob/main/docs/_static/folium_logo.jpg
25+
.. image:: https://github.com/python-visualization/folium/blob/main/docs/_static/folium_logo.png
26+
:height: 100px
2627

2728

2829
Python Data, Leaflet.js Maps

docs/_static/folium_logo.jpg

-8.54 KB
Binary file not shown.

docs/_static/folium_logo.png

1.62 KB
Loading

docs/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,21 +123,24 @@
123123
"type": "fontawesome",
124124
}
125125
],
126+
"logo": {
127+
"text": "Folium",
128+
},
126129
}
127130

128131
# Add any paths that contain custom themes here, relative to this directory.
129132
# html_theme_path = ["_themes"]
130133

131134
# The name for this set of Sphinx documents. If None, it defaults to
132135
# "<project> v<release> documentation".
133-
html_title = "Folium documentation"
136+
# html_title = "Folium documentation"
134137

135138
# A shorter title for the navigation bar. Default is the same as html_title.
136139
# html_short_title = None
137140

138141
# The name of an image file (relative to this directory) to place at the top
139142
# of the sidebar.
140-
# html_logo = None
143+
html_logo = "_static/folium_logo.png"
141144

142145
# The name of an image file (within the static path) to use as favicon of the
143146
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

docs/index.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,27 @@
33
Folium
44
######
55

6-
.. image:: _static/folium_logo.jpg
6+
.. image:: _static/folium_logo.png
7+
:height: 100px
78

8-
**Python data, leaflet.js maps**
99

10-
``folium`` builds on the data wrangling strengths of the Python ecosystem and
11-
the mapping strengths of the ``leaflet.js`` library.
12-
Manipulate your data in Python,
13-
then visualize it in on a Leaflet map via ``folium``.
10+
Python data, leaflet.js maps
11+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
12+
13+
Folium builds on the data wrangling strengths of the Python ecosystem and the
14+
mapping strengths of the `Leaflet.js <https://leafletjs.com>`_ library.
15+
Manipulate your data in Python, then visualize it in a Leaflet map via Folium.
1416

1517
Concepts
1618
========
1719

18-
``folium`` makes it easy to visualize data that's been manipulated in Python on an interactive leaflet map.
19-
It enables both the binding of data to a map for ``choropleth`` visualizations
20+
Folium makes it easy to visualize data that's been manipulated in Python on an interactive leaflet map.
21+
It enables both the binding of data to a map for choropleth visualizations
2022
as well as passing rich vector/raster/HTML visualizations as markers on the map.
2123

2224
The library has a number of built-in tilesets from OpenStreetMap,
2325
Mapbox, and Stamen, and supports custom tilesets.
24-
``folium`` supports both Image, Video, GeoJSON and TopoJSON overlays and has a
26+
Folium supports both Image, Video, GeoJSON and TopoJSON overlays and has a
2527
number of vector layers built-in.
2628

2729

0 commit comments

Comments
 (0)