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
python-visualization · Sep 6, 2023 · 57e8eae · 57e8eae
1 parent f572f9e
commit 57e8eae
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 12 deletions.
diff --git 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
diff --git a/docs/_static/folium_logo.png b/docs/_static/folium_logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -123,21 +123,24 @@
             "type": "fontawesome",
         }
     ],
+    "logo": {
+        "text": "Folium",
+    },
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = ["_themes"]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> 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
@@ -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 <https://leafletjs.com>`_ 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.