From aabede806fa0940cbfc565e9c0010ec12385fed0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= Date: Tue, 28 May 2024 09:51:21 +0200 Subject: [PATCH] chore(docs): minor changes --- docs/source/conf.py | 8 +++----- examples/qt_interactive.py | 5 ----- pyproject.toml | 2 +- 3 files changed, 4 insertions(+), 11 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d5cf6ae..71c52df 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -82,18 +82,16 @@ "reset_modules": (qtgallery.reset_qapp,), "matplotlib_animations": True, "backreferences_dir": "gen_modules/backreferences", - "doc_module": ("differt2d", "numpy", "jax", "optax", "matplotlib"), + "doc_module": ("differt2d", "equinox", "jax", "matplotlib", "optax"), "reference_url": { "differt2d": None, }, + "capture_repr": ("_repr_html_", "__repr__"), + "compress_images": ("images", "thumbnails"), "image_srcset": ["2x"], "show_api_usage": True, } -qtgallery_conf = { - "xvfb_size": (775, 1550), -} - # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/examples/qt_interactive.py b/examples/qt_interactive.py index cce4425..e9deba8 100644 --- a/examples/qt_interactive.py +++ b/examples/qt_interactive.py @@ -487,11 +487,6 @@ def on_scene_change(self) -> None: # # This part is not very interesting, and uses the builtin :mod:`argparse` # module to create a set of command-line options and parse them. -# -# .. note:: -# -# The figure canvas does not render correclty in the docs (size is too small). -# To better appreciate it, please run this example locally! if __name__ == "__main__": diff --git a/pyproject.toml b/pyproject.toml index f029cce..9314632 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -176,7 +176,7 @@ dev-dependencies = [ "sphinx>=7.2.6", "sphinx-autodoc-typehints>=1.23.2", "sphinx-copybutton>=0.5.1", - "sphinx-gallery>=0.14.0", + "sphinx-gallery>=0.16.0", "sphinxext-opengraph>=0.7.5", # examples "ipywidgets>=8.1.2",