:orphan:

sphinx-gallery
==============

Sphinx extension for generating example galleries from Python scripts.

- **Documentation**: https://sphinx-gallery.github.io/
- **Source Code**: https://github.com/sphinx-gallery/sphinx-gallery

Example
-------

The examples below demonstrate various sphinx-gallery features and provide
visual elements for theme styling purposes.



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates a simple matplotlib plot with sphinx-gallery. The first generated figure is automatically used as the gallery thumbnail.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_01_basic_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_01_basic`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Basic Plot</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates generating multiple figures in a single example. Each figure is displayed in sequence with accompanying explanatory text.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_02_multiple_figures_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_02_multiple_figures`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Multiple Figures</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create figures with multiple subplots. Subplots are useful for comparing related visualizations side by side.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_03_subplots_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_03_subplots`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Subplot Layouts</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example showcases different plot styles and annotations. It demonstrates how sphinx-gallery captures complex matplotlib figures.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_04_styled_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_04_styled`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Styled Visualizations</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how sphinx-gallery captures and displays stdout output from print() statements and other console output.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_05_output_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_05_output`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Console Output</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example intentionally raises an exception to demonstrate how sphinx-gallery displays error tracebacks in the documentation.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_06_failing_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_06_failing`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Error Output</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates a gallery entry without any figures. It shows how sphinx-gallery handles code-focused examples with extensive documentation and no visual output.">

.. only:: html

  .. image:: /extensions/sphinx-gallery/images/thumb/sphx_glr_plot_07_no_output_thumb.png
    :alt:

  :doc:`/extensions/sphinx-gallery/plot_07_no_output`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Text-Only</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /extensions/sphinx-gallery/plot_01_basic
   /extensions/sphinx-gallery/plot_02_multiple_figures
   /extensions/sphinx-gallery/plot_03_subplots
   /extensions/sphinx-gallery/plot_04_styled
   /extensions/sphinx-gallery/plot_05_output
   /extensions/sphinx-gallery/plot_06_failing
   /extensions/sphinx-gallery/plot_07_no_output


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: sphinx-gallery_python.zip </extensions/sphinx-gallery/sphinx-gallery_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: sphinx-gallery_jupyter.zip </extensions/sphinx-gallery/sphinx-gallery_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_