
.. _sphx_glr_api_reference:

Sphinx-Gallery API Reference
============================

.. note::
   Sphinx-Gallery is typically used indirectly via Sphinx execution and
   configuration variables, see :ref:`configuration` for how to do this.
   However, as a standard  Python project, we document many functions and
   classes as well below, even though these will typically not be needed
   by end users.

.. currentmodule:: sphinx_gallery

.. automodule:: sphinx_gallery
   :no-members:
   :no-inherited-members:

:py:mod:`sphinx_gallery`:

.. autosummary::
   :toctree: gen_modules/
   :template: module.rst

   gen_gallery
   backreferences
   gen_rst
   scrapers
   py_source_parser
   block_parser
   docs_resolv
   notebook
   downloads
   sorting
   directives

.. currentmodule:: sphinx_gallery.utils

.. automodule:: sphinx_gallery.utils
   :no-members:
   :no-inherited-members:

:py:mod:`sphinx_gallery.utils`:

.. autosummary::
   :toctree: gen_modules/
   :template: module.rst

   optipng
