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.
We create a 2-level nested structure by iterating through every sibling folder of the current index file. In each of these folders, we look for a section index file, for which we generate a toctree pointing to sibling scripts. Then, we append the content of this section index file to the current index file, after we remove toctree (to keep a clean nested structure) and sphinx tags (to prevent tag duplication) Eventually, we create a toctree in the current index file which points to section index files.
- sphinx_gallery.gen_gallery.get_subsections(srcdir, examples_dir, gallery_conf)[source]¶
Return the list of subsections of a gallery.
- sphinx_gallery.gen_gallery.parse_config(app, check_keys=True)[source]¶
Process the Sphinx Gallery configuration.
- 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.