Skip to content

Commit 5161074

Browse files
authored
DOC remove mention of other builder types (sphinx-gallery#698)
* remove mention of other builders * add note
1 parent 213741c commit 5161074

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

doc/getting_started.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,7 @@ this folder must have the following things:
8888
:ref:`python_script_syntax`.
8989

9090
* By default **only** files prefixed with ``plot_`` will be executed and
91-
their outputs captured to incorporate them in the HTML (or another output
92-
format depending on the `Sphinx 'builder'
93-
<https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`_ selected)
91+
their outputs captured to incorporate them in the HTML
9492
output of the script. Files without that prefix will be only parsed and
9593
presented in a rich literate programming fashion, without any output. To
9694
change the default file pattern for execution and capture see
@@ -193,13 +191,16 @@ In your Sphinx source directory, (e.g., ``myproject/doc``) execute:
193191
194192
This will start the build of your complete documentation. Both
195193
the Sphinx-Gallery output files described above and
196-
the Sphinx built HTML documentation (or another output format depending on the
197-
`Sphinx 'builder'
198-
<https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`_ selected) will
194+
the Sphinx built HTML documentation will
199195
be generated. Once a build is completed, all the outputs from your examples
200196
will be cached.
201197
In the future, only examples that have changed will be re-built.
202198

203199
You should now have a gallery built from your example scripts! For more
204200
advanced usage and configuration, check out the :ref:`advanced_usage` page or
205201
the :ref:`configuration` reference.
202+
203+
.. note::
204+
Sphinx-Gallery may work for non-HTML Sphinx `builders
205+
<https://www.sphinx-doc.org/en/master/man/sphinx-build.html>`_ but support
206+
for this is mostly untested and results may vary.

0 commit comments

Comments
 (0)