raphaelquast · raphaelquast · Jul 16, 2023 · Jul 16, 2023 · Jul 17, 2023 · Jul 17, 2023
diff --git a/docs/EOmaps_examples.rst b/docs/EOmaps_examples.rst
@@ -2,8 +2,8 @@
 
 .. _EOmaps_examples:
 
-🗺 EOmaps examples
-==================
+|iconExamples| EOmaps examples
+==============================
 
 ... a collection of examples that show how to create beautiful interactive maps.
 

diff --git a/docs/FAQ.rst b/docs/FAQ.rst
@@ -1,5 +1,6 @@
-👀 FAQ
-=======
+
+|iconFaq| FAQ
+=============
 
 .. contents:: Contents:
   :local:

diff --git a/docs/_static/icons/annotations.png b/docs/_static/icons/annotations.png
diff --git a/docs/_static/icons/basics.png b/docs/_static/icons/basics.png
diff --git a/docs/_static/icons/compass.png b/docs/_static/icons/compass.png
diff --git a/docs/_static/icons/contribution.png b/docs/_static/icons/contribution.png
diff --git a/docs/_static/icons/datavisualization.png b/docs/_static/icons/datavisualization.png
diff --git a/docs/_static/icons/draw.png b/docs/_static/icons/draw.png
diff --git a/docs/_static/icons/faq.png b/docs/_static/icons/faq.png
diff --git a/docs/_static/icons/getintouch.png b/docs/_static/icons/getintouch.png
diff --git a/docs/_static/icons/gettingstarted.png b/docs/_static/icons/gettingstarted.png
diff --git a/docs/_static/icons/gridlines.png b/docs/_static/icons/gridlines.png
diff --git a/docs/_static/icons/inset.png b/docs/_static/icons/inset.png
diff --git a/docs/_static/icons/install.png b/docs/_static/icons/install.png
diff --git a/docs/_static/icons/layout.png b/docs/_static/icons/layout.png
diff --git a/docs/_static/icons/miscellaneous.png b/docs/_static/icons/miscellaneous.png
diff --git a/docs/_static/icons/naturalearth.png b/docs/_static/icons/naturalearth.png
diff --git a/docs/_static/icons/reading.png b/docs/_static/icons/reading.png
diff --git a/docs/_static/icons/scalebar.png b/docs/_static/icons/scalebar.png
diff --git a/docs/_static/icons/utilities.png b/docs/_static/icons/utilities.png
diff --git a/docs/_static/icons/vector.png b/docs/_static/icons/vector.png
diff --git a/docs/_static/icons/webmaplayers.png b/docs/_static/icons/webmaplayers.png
diff --git a/docs/api_annotations_markers_etc.rst b/docs/api_annotations_markers_etc.rst
@@ -1,8 +1,8 @@
 
 .. _annotations_and_markers:
 
-🏕 Annotations, Markers, Logos, etc.
--------------------------------------
+|iconAnnotations| Annotations, Markers, Logos, etc.
+---------------------------------------------------
 
 .. contents:: Contents:
   :local:

diff --git a/docs/api_basics.rst b/docs/api_basics.rst
@@ -1,7 +1,7 @@
 .. _basics:
 
-🌱 Basics
----------
+|iconBasics| Basics
+-------------------
 
 .. contents:: Contents
     :depth: 1

diff --git a/docs/api_callbacks.rst b/docs/api_callbacks.rst
@@ -1,8 +1,8 @@
 
 .. _callbacks:
 
-🛸 Callbacks
--------------
+|iconCallbacks| Callbacks
+-------------------------
 
 .. contents:: Contents:
     :local:

diff --git a/docs/api_command_line_interface.rst b/docs/api_command_line_interface.rst
@@ -1,7 +1,7 @@
 .. _command_line_interface:
 
-⛭ Command Line Interface
-=========================
+|iconCli| Command Line Interface
+================================
 
 EOmaps provides a basic command line interface to quickly create simple maps or to get a quick-look at a dataset without having to open an editor.
 

diff --git a/docs/api_companion_widget.rst b/docs/api_companion_widget.rst
@@ -2,8 +2,8 @@
 
 .. _companion_widget:
 
-🧰 Companion Widget
---------------------
+|iconCompanionwidget| Companion Widget
+--------------------------------------
 
 EOmaps comes with an awesome companion widget that provides many useful features for interactive data analysis.
 

diff --git a/docs/api_compass.rst b/docs/api_compass.rst
@@ -2,8 +2,8 @@
 
 .. _compass:
 
-🧭 Compass (or North Arrow)
----------------------------
+|iconCompass| Compass (or North Arrow)
+--------------------------------------
 .. currentmodule:: eomaps.eomaps
 
 A compass can be added to the map via :py:meth:`Maps.add_compass`:

diff --git a/docs/api_data_visualization.rst b/docs/api_data_visualization.rst
@@ -1,7 +1,7 @@
 .. _visualize_data:
 
-🔴 Data Visualization
-----------------------
+|iconDatavisualization| Data Visualization
+--------------------------------------
 
 .. contents:: Contents:
     :depth: 1

diff --git a/docs/api_draw.rst b/docs/api_draw.rst
@@ -3,8 +3,8 @@
 
 .. _shape_drawer:
 
-✏️ Draw shapes on the map
--------------------------
+|iconDraw| Draw shapes on the map
+---------------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_gridlines.rst b/docs/api_gridlines.rst
@@ -1,8 +1,8 @@
 
 .. _gridlines:
 
-▦ Gridlines
-------------
+|iconGridlines| Gridlines
+-------------------------
 
 .. contents:: Contents:
     :local:

diff --git a/docs/api_inset_maps.rst b/docs/api_inset_maps.rst
@@ -1,6 +1,6 @@
 
-🔬 Inset Maps
---------------
+|iconInset| Inset Maps
+--------------------------
 
 .. contents:: Contents:
     :local:

diff --git a/docs/api_layout_editor.rst b/docs/api_layout_editor.rst
@@ -1,8 +1,8 @@
 
 .. _layout_editor:
 
-🏗️ Layout Editor
------------------
+|iconLayout| Layout Editor
+--------------------------
 
 EOmaps provides a **Layout Editor** that can be used to quickly re-arrange the positions of all axes of a figure.
 You can use it to simply drag the axes the mouse to the desired locations and change their size with the scroll-wheel.

diff --git a/docs/api_logging.rst b/docs/api_logging.rst
@@ -1,5 +1,5 @@
-📚Logging
-==========
+|iconLogging| Logging
+=====================
 
 .. currentmodule:: eomaps
 

diff --git a/docs/api_misc.rst b/docs/api_misc.rst
@@ -1,7 +1,7 @@
 
 
-🔸 Miscellaneous
-----------------
+|iconMiscellaneous| Miscellaneous
+---------------------------------
 Some additional functions and properties that might come in handy:
 
 .. currentmodule:: eomaps.eomaps

diff --git a/docs/api_naturalearth_features.rst b/docs/api_naturalearth_features.rst
@@ -1,8 +1,8 @@
 
 .. _ne_features:
 
-🌵 NaturalEarth features
-------------------------
+|iconNaturalearth| NaturalEarth features
+----------------------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_read_data.rst b/docs/api_read_data.rst
@@ -1,6 +1,6 @@
 
-📦 Reading data
-----------------
+|iconReading| Reading data
+--------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_scalebar.rst b/docs/api_scalebar.rst
@@ -1,8 +1,8 @@
 
 .. _scalebar:
 
-📏 Scalebars
-------------
+|iconScalebar| Scalebars
+------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_utils.rst b/docs/api_utils.rst
@@ -1,8 +1,8 @@
 
 .. _utility:
 
-🔦 Utilities
--------------
+|iconUtilities| Utilities
+-------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_vector_data.rst b/docs/api_vector_data.rst
@@ -1,8 +1,8 @@
 
 .. _vector_data:
 
-💠 Vector Data
----------------
+|iconVector| Vector Data
+------------------------
 
 .. currentmodule:: eomaps.eomaps
 

diff --git a/docs/api_webmaps.rst b/docs/api_webmaps.rst
@@ -1,8 +1,8 @@
 
 .. _webmap_layers:
 
-🛰 WebMap layers
-----------------
+|iconWebmaplayers| WebMap layers
+--------------------------------
 
 .. contents:: Contents:
     :local:

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,18 +1,19 @@
 # Configuration file for the Sphinx documentation builder.
-import sys, os
+import sys
+import os
+from pathlib import Path
 
 sys.path.insert(0, os.path.abspath(".." + os.sep + ".."))
 sys.path.insert(0, os.path.abspath(".."))
 
+from eomaps import Maps  # to run __init__.py
+
 
 def setup(app):
     app.add_css_file("custom_css.css")
 
 
-from eomaps import Maps  # to run __init__.py
-
 # -- Project information
-
 project = "EOmaps"
 author = "Raphael Quast"
 
@@ -75,3 +76,11 @@ def setup(app):
 
        <span style="display: inline-block; width: 20vw; height: 0px;"></span>
     """
+
+for icon in (Path(__file__).parent / "_static" / "icons").iterdir():
+    rst_prolog += (
+        "\n\n"
+        f".. |icon{icon.stem.capitalize()}| raw:: html\n"
+        "\n"
+        f"   <img style='display:inline-block; height:1.5em; width:auto; transform:translate(0, 0)' src=_static/icons/{icon.name} width=1em>\n"
+    )
diff --git a/docs/contribute.rst b/docs/contribute.rst
@@ -1,11 +1,11 @@
 .. _contribute:
 
 
-🚀 Contribution Guide
-======================
+|iconContribution| Contribution Guide
+=====================================
 
-👷 Get in touch
----------------
+|iconGetintouch| Get in touch
+-----------------------------
 
 Hey! Nice to see that you're interested in contributing to `EOmaps <https://github.com/raphaelquast/EOmaps>`_!
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -1,8 +1,8 @@
 .. _installation:
 
 
-🐛 Installation
-================
+|iconInstall| Installation
+==========================
 
 .. contents:: Contents:
     :local:
@@ -11,7 +11,7 @@
 Recommended way (via ``conda`` and ``mamba``)
 ---------------------------------------------
 
-EOmaps is available via the ``conda-forge`` channel and can be installed via:
+EOmaps is  available via the ``conda-forge`` channel and can be installed via:
 
   .. code-block:: console