sphinx_gallery.directives#
Custom Sphinx directives#
Functions#
Classes#
- class sphinx_gallery.directives.ImageSg(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#
Implements a directive to allow an optional hidpi image. Meant to be used with the image_srcset configuration option.
e.g.:
.. image-sg:: /plot_types/basic/images/sphx_glr_bar_001.png :alt: bar :srcset: /plot_types/basic/images/sphx_glr_bar_001.png, /plot_types/basic/images/sphx_glr_bar_001_2_00x.png 2.00x :class: sphx-glr-single-img
The resulting html is:
<img src="sphx_glr_bar_001_hidpi.png" srcset="_images/sphx_glr_bar_001.png, _images/sphx_glr_bar_001_2_00x.png 2x", alt="bar" class="sphx-glr-single-img" />
- final_argument_whitespace = False#
May the final argument contain whitespace?
- has_content = False#
May the directive have content?
- option_spec = {'alt': <function unchanged>, 'class': <function class_option>, 'srcset': <function unchanged>}#
Mapping of option names to validator functions.
- optional_arguments = 3#
Number of optional arguments after the required arguments.
- required_arguments = 1#
Number of required directive arguments.
- class sphinx_gallery.directives.MiniGallery(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#
Custom directive to insert a mini-gallery
The required argument is one or more fully qualified names of objects, separated by spaces. The mini-gallery will be the subset of gallery examples that make use of that object (from that specific namespace).
Options:
add-heading adds a heading to the mini-gallery. If an argument is provided, it uses that text for the heading. Otherwise, it uses default text.
heading-level specifies the heading level of the heading as a single character. If omitted, the default heading level is ‘^’.
- final_argument_whitespace = True#
May the final argument contain whitespace?
- option_spec = {'add-heading': <function unchanged>, 'heading-level': <function single_char_or_unicode>}#
Mapping of option names to validator functions.
- optional_arguments = 0#
Number of optional arguments after the required arguments.
- required_arguments = 1#
Number of required directive arguments.