From e0956723ea7abdfc36c1a2b384cd16521faa29f4 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Wed, 2 Nov 2022 00:29:11 +0100 Subject: [PATCH] DOC: Minor cleanup in "Writing documentation" The make option `-Dplot_gallery=0` is superseeded by `make html-noplot`. While we have removed it from the simple calls (#23870), it was still present in examples with multiple options. Remove it here and replace it by a still used option. --- doc/devel/documenting_mpl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 23b332925fd9..b814e67cd308 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -91,14 +91,14 @@ You can use the ``O`` variable to set additional options: * ``make O=-j4 html`` runs a parallel build with 4 processes. * ``make O=-Dplot_formats=png:100 html`` saves figures in low resolution. -Multiple options can be combined, e.g. ``make O='-j4 -Dplot_gallery=0' +Multiple options can be combined, e.g. ``make O='-j4 -Dplot_formats=png:100' html``. On Windows, set the options as environment variables, e.g.: .. code-block:: bat - set SPHINXOPTS= & set O=-j4 -Dplot_gallery=0 & make html + set SPHINXOPTS= & set O=-j4 -Dplot_formats=png:100 & make html Showing locally built docs --------------------------