remove primary sidebar on API-reference landing page and add proper h…

…eaders
raphaelquast · Aug 25, 2024 · ddab920 · ddab920
1 parent 2f14b1f
commit ddab920
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 6 deletions.
diff --git a/docs/source/api/reference.rst b/docs/source/api/reference.rst
@@ -4,7 +4,10 @@ API Reference
 
 .. currentmodule:: eomaps.eomaps
 
-.. card:: The Maps object
+The Maps object
+===============
+
+.. card::
     :link: ../generated/eomaps.eomaps.Maps
     :link-type: doc
 
@@ -22,14 +25,20 @@ Feature objects
 ===============
 
 
+InsetMaps
+---------
+
 .. card::
     :shadow: none
 
-    .. card:: InsetMaps
+    .. card::
         :link: ../generated/eomaps.inset_maps.InsetMaps
         :link-type: doc
         :margin: 0
 
+        :py:class:`InsetMaps` objects highlight specific areas on a map.
+
+
         .. currentmodule:: eomaps.inset_maps
 
         .. autosummary::
@@ -46,14 +55,19 @@ Feature objects
     See :py:meth:`Maps.new_inset_map` on how to create a new InsetMap!
 
 
+ColorBar
+--------
+
 .. card::
     :shadow: none
 
-    .. card:: ColorBar
+    .. card::
         :link: ../generated/eomaps.colorbar.ColorBar
         :link-type: doc
         :margin: 0
 
+        :py:class:`ColorBar` objects visualize the color- and value-distribution of plotted datasets.
+
         .. currentmodule:: eomaps.colorbar
 
         .. autosummary::
@@ -69,16 +83,23 @@ Feature objects
 
     See :py:meth:`Maps.add_colorbar` on how to add a colorbar to a map!
 
+
+GridLines
+---------
+
 .. card::
     :shadow: none
 
-    .. card:: GridLines
+    .. card::
         :link: ../generated/eomaps.grid.GridLines
         :link-type: doc
         :margin: 0
 
         .. currentmodule:: eomaps.grid
 
+        :py:class:`GridLines` objects add lon/lat grids to a map.
+
+
         .. autosummary::
             :toctree: ../generated
             :template: custom-class-template.rst
@@ -93,16 +114,22 @@ Feature objects
     See :py:meth:`Maps.add_gridlines` on how to add grid-lines to a map!
 
 
+Compass
+-------
+
 .. card::
     :shadow: none
 
-    .. card:: Compass
+    .. card::
         :link: ../generated/eomaps.compass.Compass
         :link-type: doc
         :margin: 0
 
         .. currentmodule:: eomaps.compass
 
+        :py:class:`Compass` objects indicate the cardinal directions for a point on a map.
+
+
         .. autosummary::
             :toctree: ../generated
             :template: custom-class-template.rst
@@ -116,16 +143,22 @@ Feature objects
 
     See :py:meth:`Maps.add_compass` on how to add a compass (or North-arrow) to a map!
 
+Scalebar
+--------
+
 .. card::
     :shadow: none
 
-    .. card:: ScaleBar
+    .. card::
         :link: ../generated/eomaps.scalebar.ScaleBar
         :link-type: doc
         :margin: 0
 
         .. currentmodule:: eomaps.scalebar
 
+        :py:class:`ScaleBar` objects measure distances on a map.
+
+
         .. autosummary::
             :toctree: ../generated
             :template: custom-class-template.rst

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -147,6 +147,7 @@ def setup(app):
     "contribute/contribute": [],
     "installation": [],
     "FAQ": [],
+    "api/reference": [],
 }
 
 html_theme_options = {