Merge pull request #29017 from timhoffm/doc-figure-size

QuLogic · web-flow · commit e8654e11da36 · 2024-10-31T06:21:34.000-04:00
DOC: Document preferred figure size for examples
diff --git 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
 =============
 
