From 31680184517794e63f8650d6889a5c1d748c473c Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Thu, 24 Oct 2024 12:19:12 +0200 Subject: [PATCH] DOC: Document preferred figure size for examples --- doc/devel/document.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/devel/document.rst b/doc/devel/document.rst index 81b44a830c34..0d746fb69318 100644 --- a/doc/devel/document.rst +++ b/doc/devel/document.rst @@ -1106,6 +1106,13 @@ minimal amount of code necessary to showcase the feature. The lack of extraneous makes it easier for the reader to map which parts of code correspond to which parts of the plot. +Figure size +^^^^^^^^^^^ +When customizing figure sizes, we aim to avoid downscaling in rendered HTML docs. +The current width limit (induced by *pydata-sphinx-theme*) is 720px, i.e. +``figsize=(7.2, ...)``, or 896px if the page does not have subsections and +thus does not have the "On this page" navigation on the right-hand side. + Miscellaneous =============