﻿.. Please when editing this file make sure to keep it matching the
   docs in ../configuration.rst:reference_to_examples

sphinx_gallery.gen_gallery
==========================

.. automodule:: sphinx_gallery.gen_gallery

   
   

   Functions
   ---------

   

   .. autofunction:: clean_api_usage_files

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.clean_api_usage_files:

   .. minigallery:: sphinx_gallery.gen_gallery.clean_api_usage_files
       :add-heading:

   .. autofunction:: fill_gallery_conf_defaults

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.fill_gallery_conf_defaults:

   .. minigallery:: sphinx_gallery.gen_gallery.fill_gallery_conf_defaults
       :add-heading:

   .. autofunction:: generate_gallery_rst

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.generate_gallery_rst:

   .. minigallery:: sphinx_gallery.gen_gallery.generate_gallery_rst
       :add-heading:

   .. autofunction:: get_default_config_value

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.get_default_config_value:

   .. minigallery:: sphinx_gallery.gen_gallery.get_default_config_value
       :add-heading:

   .. autofunction:: get_subsections

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.get_subsections:

   .. minigallery:: sphinx_gallery.gen_gallery.get_subsections
       :add-heading:

   .. autofunction:: setup

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.setup:

   .. minigallery:: sphinx_gallery.gen_gallery.setup
       :add-heading:

   .. autofunction:: setup_module

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.setup_module:

   .. minigallery:: sphinx_gallery.gen_gallery.setup_module
       :add-heading:

   .. autofunction:: setup_template_link_getters

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.setup_template_link_getters:

   .. minigallery:: sphinx_gallery.gen_gallery.setup_template_link_getters
       :add-heading:

   .. autofunction:: summarize_failing_examples

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.summarize_failing_examples:

   .. minigallery:: sphinx_gallery.gen_gallery.summarize_failing_examples
       :add-heading:

   .. autofunction:: touch_empty_backreferences

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.touch_empty_backreferences:

   .. minigallery:: sphinx_gallery.gen_gallery.touch_empty_backreferences
       :add-heading:

   .. autofunction:: update_gallery_conf_builder_inited

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.update_gallery_conf_builder_inited:

   .. minigallery:: sphinx_gallery.gen_gallery.update_gallery_conf_builder_inited
       :add-heading:

   .. autofunction:: write_api_entries

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.write_api_entries:

   .. minigallery:: sphinx_gallery.gen_gallery.write_api_entries
       :add-heading:

   .. autofunction:: write_api_entry_usage

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.write_api_entry_usage:

   .. minigallery:: sphinx_gallery.gen_gallery.write_api_entry_usage
       :add-heading:

   .. autofunction:: write_computation_times

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.write_computation_times:

   .. minigallery:: sphinx_gallery.gen_gallery.write_computation_times
       :add-heading:

   .. autofunction:: write_junit_xml

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.write_junit_xml:

   .. minigallery:: sphinx_gallery.gen_gallery.write_junit_xml
       :add-heading:
   
   

   
   

   Classes
   -------

   
   .. autoclass:: DefaultResetArgv
      :members:

   .. _sphx_glr_backref_sphinx_gallery.gen_gallery.DefaultResetArgv:

   .. minigallery:: sphinx_gallery.gen_gallery.DefaultResetArgv
       :add-heading:
   
   

   
   
   