From dce9582ef2c44afdd75c731f512413e447658746 Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 16 Aug 2022 16:31:15 -0400 Subject: [PATCH 1/2] working windows built docs edited it so at least the docs are now accurate, hopefully once #23634 goes in, either as part of that PR or new one the docs can be amended yet again to add > On Windows, either put the arguments at the end of the statement or set the options as environment variables, e.g.: ```bat set O=-W --keep-going -j4 & make html ``` --- doc/devel/documenting_mpl.rst | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 2bd28aad3315..2b526047b7c8 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -82,12 +82,6 @@ it, use make SPHINXOPTS= html -On Windows the arguments must be at the end of the statement: - -.. code-block:: bat - - make html SPHINXOPTS= - You can use the ``O`` variable to set additional options: * ``make O=-j4 html`` runs a parallel build with 4 processes. @@ -97,12 +91,8 @@ You can use the ``O`` variable to set additional options: Multiple options can be combined using e.g. ``make O='-j4 -Dplot_gallery=0' html``. -On Windows, either put the arguments at the end of the statement or set the options as environment variables, e.g.: +On Windows, edit the :file:`doc/make.bat` to enable flags. -.. code-block:: bat - - set O=-W --keep-going -j4 - make html Showing locally built docs -------------------------- From 4524338d0f9d381e1c935af35ee0c27192cc49bc Mon Sep 17 00:00:00 2001 From: hannah Date: Tue, 16 Aug 2022 16:38:21 -0400 Subject: [PATCH 2/2] whitespace --- doc/devel/documenting_mpl.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 2b526047b7c8..649101f608f5 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -91,7 +91,7 @@ You can use the ``O`` variable to set additional options: Multiple options can be combined using e.g. ``make O='-j4 -Dplot_gallery=0' html``. -On Windows, edit the :file:`doc/make.bat` to enable flags. +On Windows, edit the :file:`doc/make.bat` to enable flags. Showing locally built docs