..code-block::sh

Linux, macOS

The documentation is built using the ``Makefile`` file and parameters

can be set either in the ``Makefile`` or on the command line.

The ``SPHINXOPTS`` variable is set to ``-W`` by default to turn warnings into

errors. To unset it, use

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.

* ``make O=-Dplot_gallery=0 html`` skips the gallery build.

..code-block::sh

Windows

..note::

It is currently not possible to build the gallery on windows due to a

problem in sphinx-gallery that should be fixed in version 0.1.14. A

workaround is to not build the gallery by commenting out

``sphinx_gallery.gen_gallery`` in ``extensions`` in the ``conf.py`` file

or to delete the code in or delete the

``examples\userdemo\pgf_preamble_sgskip.py`` file.

The documentation is build using the ``make.bat`` file. The options are set using

environment variables and varibales can be set either in the

``make.bat`` file or set on the command line befor running ``make.bat``.

Environment variables are set with

..code-block::sh

Multiple options can be combined using e.g. ``make O='-j4 -Dplot_gallery=0'

html``.

Set ``SPHINXOPTS`` to ``-W`` to turn warnings into errors.

You can use the ``O`` variable to set additional options, for example (see

linux, macOS above for more options)

On Windows, options needs to be set as environment variables, e.g. ``set O=-W

-j4 & make html``.

..code-block::sh

The total command is then run with

..code-block::sh

There is no difference between the variables ``SPHINXOPTS`` and ``O`` and both

are unset at the end of the ``make.bat`` file if cmd is used but not if

powershell is used. So a variable must be unset manually with

..code-block::sh

in powershell before running ``make.bat`` again if the default behavior is

wanted.

.. _writing-rest-pages:

Writing ReST pages

setSOURCEDIR=.

setBUILDDIR=build

setSPHINXPROJ=matplotlib

setSPHINXOPTS=-W

iferrorlevel9009 (

if"%1"==""goto help

echo%SPHINXBUILD% -M%1%SOURCEDIR%%BUILDDIR%%SPHINXOPTS%%O%

%SPHINXBUILD% -M%1%SOURCEDIR%%BUILDDIR%%SPHINXOPTS%%O%

goto end

:help

%SPHINXBUILD% -M help%SOURCEDIR%%BUILDDIR%%SPHINXOPTS%%O%

:end