sphinx gallery

docs/source/conf.py

@@ -2,7 +2,24 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+
+# need to force offscreen rendering before importing fpl
+# otherwise fpl tries to select glfw canvas
+os.environ["WGPU_FORCE_OFFSCREEN"] = "1"
+
 import fastplotlib
+from pygfx.utils.gallery_scraper import find_examples_for_gallery
+from pathlib import Path
+import sys
+from sphinx_gallery.sorting import ExplicitOrder
+import imageio.v3 as iio
+
+ROOT_DIR = Path(__file__).parents[1].parents[0]  # repo root
+EXAMPLES_DIR = Path.joinpath(ROOT_DIR, "examples", "desktop")
+
+sys.path.insert(0, str(ROOT_DIR))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -23,9 +40,40 @@
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
     "sphinx_design",
-    "nbsphinx",
+    "sphinx_gallery.gen_gallery"
 ]
 
+sphinx_gallery_conf = {
+    "gallery_dirs": "_gallery",
+    "backreferences_dir": "_gallery/backreferences",
+    "doc_module": ("fastplotlib",),
+    "image_scrapers": ("pygfx",),
+    "remove_config_comments": True,
+    "subsection_order": ExplicitOrder(
+        [
+            "../../examples/desktop/image",
+            "../../examples/desktop/gridplot",
+            "../../examples/desktop/line",
+            "../../examples/desktop/line_collection",
+            "../../examples/desktop/scatter",
+            "../../examples/desktop/heatmap",
+            "../../examples/desktop/misc"
+        ]
+    ),
+    "ignore_pattern": r'__init__\.py',
+    "nested_sections": False,
+    "thumbnail_size": (250, 250)
+}
+
+extra_conf = find_examples_for_gallery(EXAMPLES_DIR)
+sphinx_gallery_conf.update(extra_conf)
+
+# download imageio examples for the gallery
+iio.imread("imageio:clock.png")
+iio.imread("imageio:astronaut.png")
+iio.imread("imageio:coffee.png")
+iio.imread("imageio:hubble_deep_field.png")
+
 autosummary_generate = True
 
 templates_path = ["_templates"]
@@ -52,12 +100,12 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
-    "pygfx": ("https://pygfx.readthedocs.io/en/latest", None),
+    "pygfx": ("https://pygfx.com/stable/", None),
     "wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
 }
 
 html_theme_options = {
-    "source_repository": "https://github.com/kushalkolar/fastplotlib",
+    "source_repository": "https://github.com/fastplotlib/fastplotlib",
     "source_branch": "main",
     "source_directory": "docs/",
 }

docs/source/index.rst

@@ -1,12 +1,6 @@
 Welcome to fastplotlib's documentation!
 =======================================
 
-.. toctree::
-    :caption: Quick Start
-    :maxdepth: 2
-
-    quickstart
-
 .. toctree::
    :caption: User Guide
    :maxdepth:  2
@@ -26,6 +20,12 @@ Welcome to fastplotlib's documentation!
    Utils <api/utils>
    GPU <api/gpu>
 
+.. toctree::
+   :caption: Gallery
+   :maxdepth:  1
+
+   Gallery <_gallery/index>
+
 Summary
 =======