==============
Sphinx-Gallery
==============

.. include:: ../README.rst
   :start-after: tagline-begin-content
   :end-before: tagline-end-content

Features
========

* 🚀 :ref:`Create example galleries <create_simple_gallery>` automatically
  by running pure Python example scripts while capturing outputs + figures,
  rendering them into reST files built into your documentation by Sphinx:
* 📝 :ref:`embedding_rst`, allowing you to interweave narrative-like content
  with code that generates plots in your documentation. Sphinx-Gallery also
  automatically generates a Jupyter Notebook for each your example page.
* 📋 :ref:`references_to_examples`. Sphinx-Gallery can generate mini-galleries
  listing all examples that use a particular function/method/etc.
* 🔗 :ref:`link_to_documentation`. Sphinx-Gallery can automatically add links to
  API documentation for functions/methods/classes that are used in your
  examples (for any Python module that uses intersphinx).
* 🗒️ :ref:`multiple_galleries_config` to create and embed galleries for several
  folders of examples.

.. _install_sg:

Installation
============

.. include:: ../README.rst
   :start-after: installation-begin-content
   :end-before: installation-end-content

How to cite
===========

.. include:: ../README.rst
   :start-after: citation-begin-content
   :end-before: citation-end-content

.. This sets the top-level (middle) header items of pydata-sphinx-theme

Contribute
==========

Thank you for your interest! Please see our
 :ref:`contributing guide <contribute-guide>` to get started.


.. toctree::
   :hidden:

   User guide <usage>
   Advanced <advanced_index>
   Demo galleries <galleries>
   Contribution Guide <contribute>
   Changelog <changes>
