Skip to content

Commit

Permalink
Update instructions for Jupyter notebook galleries
Browse files Browse the repository at this point in the history
  • Loading branch information
mgeier committed Aug 15, 2024
1 parent fa55fc1 commit 51cf619
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions docs/user/guides/jupyter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,21 +237,10 @@ Creating galleries of examples using notebooks

`nbsphinx`_ has support for :doc:`creating thumbnail galleries from a list of Jupyter
notebooks <nbsphinx:subdir/gallery>`.
This functionality relies on `Sphinx-Gallery <https://sphinx-gallery.github.io/>`_
and extends it to work with Jupyter notebooks rather than Python scripts.
This functionality is inspired by, but doesn't depend on
`Sphinx-Gallery <https://sphinx-gallery.github.io/>`_.

To use it, you will need to install both nbsphinx and Sphinx-Gallery,
and modify your ``conf.py`` as follows:

.. code-block:: python
:caption: conf.py
extensions = [
"nbsphinx",
"sphinx_gallery.load_style",
]
After doing that, there are two ways to create the gallery:
There are two ways to create the gallery:

- From a reStructuredText source file, using the ``.. nbgallery::`` directive,
:ref:`as showcased in the
Expand Down

0 comments on commit 51cf619

Please sign in to comment.