DOC: Add note about using sphinx-gallery<0.11

spatialaudio · Jan 13, 2023 · 1c33914 · 1c33914
1 parent 23869df
commit 1c33914
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/subdir/gallery.ipynb b/doc/subdir/gallery.ipynb
@@ -37,6 +37,19 @@
     "\n",
     "You'll need Sphinx-Gallery version 0.6 or higher.\n",
     "\n",
+    "<div class=\"alert alert-info\">\n",
+    "\n",
+    "Note\n",
+    "\n",
+    "Sphinx-Gallery has changed its CSS classes in version 0.11\n",
+    "in an incompatible way (see [issue #655](https://github.com/spatialaudio/nbsphinx/issues/655)).\n",
+    "To restore the intended look, update your dependencies\n",
+    "to an older version:\n",
+    "\n",
+    "    sphinx-gallery<0.11\n",
+    "\n",
+    "</div>\n",
+    "\n",
     "However, you can also create your own CSS styles if you prefer\n",
     "(then you don't need to install Sphinx-Gallery).\n",
     "You can load your CSS files with\n",