From 3de5e2c9654b77e0f140edad0929d516089b3e19 Mon Sep 17 00:00:00 2001 From: Julien Schueller Date: Wed, 4 Jan 2023 15:03:25 +0100 Subject: [PATCH] imagmath: Update render_math docstring --- sphinx/ext/imgmath.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/sphinx/ext/imgmath.py b/sphinx/ext/imgmath.py index d1c1e8fa1da..5e8064d1cf9 100644 --- a/sphinx/ext/imgmath.py +++ b/sphinx/ext/imgmath.py @@ -209,10 +209,9 @@ def render_math( """Render the LaTeX math expression *math* using latex and dvipng or dvisvgm. - Return the filename relative to the built document and the "depth", + Return the image absolute filename and the "depth", that is, the distance of image bottom and baseline in pixels, if the option to use preview_latex is switched on. - Also return the temporary and destination files. Error handling may seem strange, but follows a pattern: if LaTeX or dvipng (dvisvgm) aren't available, only a warning is generated (since that enables