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)[source]¶ Check for duplicate filenames across gallery directories.
-
sphinx_gallery.gen_gallery.
check_spaces_in_filenames
(files)[source]¶ Check for spaces in filenames across example directories.
-
sphinx_gallery.gen_gallery.
collect_gallery_files
(examples_dirs, gallery_conf)[source]¶ Collect python files from the gallery example directories.
-
sphinx_gallery.gen_gallery.
generate_gallery_rst
(app)[source]¶ Generate the Main examples gallery reStructuredText
Start the sphinx-gallery configuration and recursively scan the examples directories in order to populate the examples gallery
-
sphinx_gallery.gen_gallery.
get_subsections
(srcdir, examples_dir, gallery_conf)[source]¶ Return the list of subsections of a gallery.
-
sphinx_gallery.gen_gallery.
summarize_failing_examples
(app, exception)[source]¶ Collects the list of falling examples and prints them with a traceback.
Raises ValueError if there where failing examples.