This notebook is part of the nbsphinx
documentation: https://nbsphinx.readthedocs.io/.
You can create
thumbnail galleries in reST files,
but you can also create such galleries in Jupyter notebooks
by adding the nbsphinx-gallery
cell tag or metadata,
which is used just like the
nbsphinx-toctree cell tag/metadata.
For possible options, see the toctree notebook.
Note
In LaTeX output this behaves just like toctree
,
i.e. no thumbnail gallery is shown,
but the linked files are included in the document.
Like with toctree
you should avoid adding content
after a gallery (except other toctrees and galleries)
because this content would appear in the LaTeX output
after the content of all included source files,
which is probably not what you want.
The following cell has the nbsphinx-gallery
tag,
which creates a thumbnail gallery.
The first section title in that cell (if available)
is used as caption
(unless it is already given in the metadata).
The notebooks in the following gallery describe different ways
how to select which images are used as thumbnails.
The notebooks are added as sub-sections under the current section,
just like when using toctree
.
If you want to create a gallery from links to notebooks
that are already included somewhere else,
you can use nbsphinx-link-gallery.
This section title will be used as caption
:
This paragraph will be ignored. Only links and the first section title are scanned, everything else is ignored.
... because only the first title in this cell is used.