diff --git a/README.rst b/README.rst index 43332966f..f2f6a6b4f 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,8 @@ folium ====== -.. image:: https://github.com/python-visualization/folium/blob/main/docs/_static/folium_logo.jpg +.. image:: https://github.com/python-visualization/folium/blob/main/docs/_static/folium_logo.png + :height: 100px Python Data, Leaflet.js Maps diff --git a/docs/_static/folium_logo.jpg b/docs/_static/folium_logo.jpg deleted file mode 100644 index 3875c7b6b..000000000 Binary files a/docs/_static/folium_logo.jpg and /dev/null differ diff --git a/docs/_static/folium_logo.png b/docs/_static/folium_logo.png new file mode 100644 index 000000000..9b12f6435 Binary files /dev/null and b/docs/_static/folium_logo.png differ diff --git a/docs/conf.py b/docs/conf.py index 0b78137dc..15d12e548 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -123,6 +123,9 @@ "type": "fontawesome", } ], + "logo": { + "text": "Folium", + }, } # Add any paths that contain custom themes here, relative to this directory. @@ -130,14 +133,14 @@ # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -html_title = "Folium documentation" +# html_title = "Folium documentation" # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -# html_logo = None +html_logo = "_static/folium_logo.png" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/docs/index.rst b/docs/index.rst index dcc20f260..68f59e496 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,25 +3,27 @@ Folium ###### -.. image:: _static/folium_logo.jpg +.. image:: _static/folium_logo.png + :height: 100px -**Python data, leaflet.js maps** -``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``. +Python data, leaflet.js maps +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +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 a Leaflet map via Folium. Concepts ======== -``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 +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 rich vector/raster/HTML visualizations as markers on the map. The library has a number of built-in tilesets from OpenStreetMap, Mapbox, and Stamen, and supports custom tilesets. -``folium`` supports both Image, Video, GeoJSON and TopoJSON overlays and has a +Folium supports both Image, Video, GeoJSON and TopoJSON overlays and has a number of vector layers built-in.