sphinx_gallery.gen_gallery¶

Sphinx-Gallery Generator¶

Attaches Sphinx-Gallery to Sphinx in order to generate the galleries when building the documentation.

Functions¶

sphinx_gallery.gen_gallery.check_duplicate_filenames(files)¶

Check for duplicate filenames across gallery directories.

Examples using sphinx_gallery.gen_gallery.check_duplicate_filenames¶

sphinx_gallery.gen_gallery.check_spaces_in_filenames(files)¶

Check for spaces in filenames across example directories.

Examples using sphinx_gallery.gen_gallery.check_spaces_in_filenames¶

sphinx_gallery.gen_gallery.collect_gallery_files(examples_dirs, gallery_conf)¶

Collect python files from the gallery example directories.

Examples using sphinx_gallery.gen_gallery.collect_gallery_files¶

sphinx_gallery.gen_gallery.cost_name_key(cost_name)¶

Examples using sphinx_gallery.gen_gallery.cost_name_key¶

sphinx_gallery.gen_gallery.generate_gallery_rst(app)¶

Generate the Main examples gallery reStructuredText

Start the sphinx-gallery configuration and recursively scan the examples directories in order to populate the examples gallery

Examples using sphinx_gallery.gen_gallery.generate_gallery_rst¶

sphinx_gallery.gen_gallery.get_default_config_value(key)¶

Examples using sphinx_gallery.gen_gallery.get_default_config_value¶

sphinx_gallery.gen_gallery.get_subsections(srcdir, examples_dir, gallery_conf)¶

Return the list of subsections of a gallery.

Parameters
  • srcdir (str) – absolute path to directory containing conf.py

  • examples_dir (str) – path to the examples directory relative to conf.py

  • gallery_conf (dict) – The gallery configuration.

Returns

out – sorted list of gallery subsection folder names

Return type

list

Examples using sphinx_gallery.gen_gallery.get_subsections¶

sphinx_gallery.gen_gallery.parse_config(app)¶

Process the Sphinx Gallery configuration

Examples using sphinx_gallery.gen_gallery.parse_config¶

sphinx_gallery.gen_gallery.setup(app)¶

Setup sphinx-gallery sphinx extension

Examples using sphinx_gallery.gen_gallery.setup¶

sphinx_gallery.gen_gallery.setup_module()¶

Examples using sphinx_gallery.gen_gallery.setup_module¶

sphinx_gallery.gen_gallery.summarize_failing_examples(app, exception)¶

Collects the list of falling examples and prints them with a traceback.

Raises ValueError if there where failing examples.

Examples using sphinx_gallery.gen_gallery.summarize_failing_examples¶

sphinx_gallery.gen_gallery.touch_empty_backreferences(app, what, name, obj, options, lines)¶

Generate empty back-reference example files.

This avoids inclusion errors/warnings if there are no gallery examples for a class / module that is being parsed by autodoc

Examples using sphinx_gallery.gen_gallery.touch_empty_backreferences¶

sphinx_gallery.gen_gallery.write_computation_times(gallery_conf, target_dir, costs)¶

Examples using sphinx_gallery.gen_gallery.write_computation_times¶

sphinx_gallery.gen_gallery.write_junit_xml(gallery_conf, target_dir, costs)¶

Examples using sphinx_gallery.gen_gallery.write_junit_xml¶

Classes¶

class sphinx_gallery.gen_gallery.DefaultResetArgv¶

Examples using sphinx_gallery.gen_gallery.DefaultResetArgv¶

Python

Navigation

  • sphinx_gallery.gen_gallery
    • Sphinx-Gallery Generator
      • Functions
        • Examples using sphinx_gallery.gen_gallery.check_duplicate_filenames
        • Examples using sphinx_gallery.gen_gallery.check_spaces_in_filenames
        • Examples using sphinx_gallery.gen_gallery.collect_gallery_files
        • Examples using sphinx_gallery.gen_gallery.cost_name_key
        • Examples using sphinx_gallery.gen_gallery.generate_gallery_rst
        • Examples using sphinx_gallery.gen_gallery.get_default_config_value
        • Examples using sphinx_gallery.gen_gallery.get_subsections
        • Examples using sphinx_gallery.gen_gallery.parse_config
        • Examples using sphinx_gallery.gen_gallery.setup
        • Examples using sphinx_gallery.gen_gallery.setup_module
        • Examples using sphinx_gallery.gen_gallery.summarize_failing_examples
        • Examples using sphinx_gallery.gen_gallery.touch_empty_backreferences
        • Examples using sphinx_gallery.gen_gallery.write_computation_times
        • Examples using sphinx_gallery.gen_gallery.write_junit_xml
      • Classes
        • Examples using sphinx_gallery.gen_gallery.DefaultResetArgv
  • sphinx_gallery.backreferences
  • sphinx_gallery.gen_rst
  • sphinx_gallery.py_source_parser
  • sphinx_gallery.docs_resolv
  • sphinx_gallery.notebook
  • sphinx_gallery.downloads
  • sphinx_gallery.docs_resolv
  • sphinx_gallery.sorting
  • Gallery of Examples
  • Future examples

Related Topics

  • Documentation overview
    • Previous: Tiny test build
    • Next: sphinx_gallery.backreferences

Quick search

©. | Powered by Sphinx 2.2.2 & Alabaster 0.7.12 | Page source