pydata sphinx theme & index fixes

alasdairwilson · Jun 26, 2024 · 1c0a62d · 1c0a62d
1 parent 739973b
commit 1c0a62d
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -99,7 +99,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "alabaster"
+html_theme = "pydata_sphinx_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -124,9 +124,12 @@
     'filename_pattern': '^((?!skip_).)*$',
     'examples_dirs': os.path.join('..', 'examples'),
     'subsection_order': ExplicitOrder([
-        '../examples/io/',
+        '../examples/io',
     ]),
     'within_subsection_order': ExampleTitleSortKey,
     'gallery_dirs': os.path.join('generated', 'gallery'),
     'matplotlib_animations': True,
+    'plot_gallery': True,
+    'remove_config_comments': True,
+    'only_warn_on_example_error': True,
 }
diff --git a/docs/index.rst b/docs/index.rst
@@ -11,7 +11,7 @@ It provides an interface for reading in and processing images of water-air inter
     :gutter: 1
 
     .. grid-item-card:: Example gallery
-        :link: generated/gallery
+        :link: generated/gallery/index
         :text-align: center
 
         :material-outlined:`palette;8em;sd-text-secondary`

diff --git a/examples/README.rst b/examples/README.rst
@@ -1,2 +1,2 @@
-example gallery for ripplemapper
-================================
+Example Gallery
+================
diff --git a/examples/io/README.rst b/examples/io/README.rst
@@ -1,4 +1,4 @@
-Example Gallery for `ripplemapper.io`
-======================================
+Using `ripplemapper.io`
+=======================
 
 Examples showing how to load data into ripplemapper.
diff --git a/examples/io/loading_a_directory.py b/examples/io/loading_a_directory.py
@@ -1,7 +1,7 @@
 """
-=========================================================
-Loading an directory of images into a RippleImage objets
-=========================================================
+========================================================
+Loading a directory of images into RippleImage objects
+========================================================
 
 Ripplemapper is capable of loading a directory of images into a list of RippleImage objects.
 """

diff --git a/pyproject.toml b/pyproject.toml
@@ -42,6 +42,7 @@ docs = [
   "sphinx-design>=0.2.0",
   "sphinx-gallery>=0.13.0",
   "sphinx-hoverxref>=1.3.0",
+  "pydata-sphinx-theme>=0.15.4",
 ]
 
 [tool.setuptools]