Skip to content

Commit 490e1fe

Browse files
committed
changes for make.bat file
1 parent d20c6cc commit 490e1fe

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

doc/source/how-to/documenting.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -269,16 +269,28 @@ Building documentation locally is time consuming in these cases,
269269
particularly if you need to test changes only in the documentation excluding the examples.
270270

271271
To generate documentation without examples, use command ``make html-noplot`` with
272-
appropriate changes in ``make.bat`` and ``Makefile``. Change needed for ``Makefile``
273-
is mentioned below. Refer `sphinx-gallery documentation
272+
appropriate changes in ``make.bat`` and ``Makefile``as
273+
mentioned below. Refer `sphinx-gallery documentation
274274
<https://sphinx-gallery.github.io/stable/configuration.html#building-without-executing-examples>`_.
275275
276-
.. code:: shell
276+
.. tab-set::
277+
278+
.. tab-item:: Makefile
279+
280+
.. code:: shell
281+
282+
html-noplot:
283+
$(SPHINXBUILD) -D plot_gallery=0 -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
284+
@echo
285+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
286+
287+
288+
.. tab-item:: make.bat
289+
290+
.. code:: shell
277291
278-
html-noplot:
279-
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
280-
@echo
281-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
292+
:html-noplot
293+
%SPHINXBUILD% -D plot_gallery=0 -b html %SOURCEDIR% %BUILDDIR%/html %SPHINXOPTS% %O%
282294
283295
Alternatively, you can modify ``sphinx_gallery_conf`` in ``conf.py`` as shown below
284296

0 commit comments

Comments
 (0)