module sphinxext.sphinximages.sphinxtrib.images
¶
Short summary¶
module pyquickhelper.sphinxext.sphinximages.sphinxtrib.images
Sphinx extension for images.
Classes¶
class |
truncated documentation |
---|---|
sphinx node |
|
sphinx node |
|
Directive which overrides default sphinx directive. It’s backward compatibile and it’s adding more cool stuff. |
Functions¶
function |
truncated documentation |
---|---|
local function |
|
local function |
|
Downloads images before running the documentation. |
|
Guesses an extension for an image. |
|
local function |
|
setup for sphinx extension |
Properties¶
property |
truncated documentation |
---|---|
|
Return the document root node of the tree containing this Node. |
|
Return the document root node of the tree containing this Node. |
Methods¶
method |
truncated documentation |
---|---|
|
|
local function |
|
|
Documentation¶
Sphinx extension for images.
- class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.ImageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Directive which overrides default sphinx directive. It’s backward compatibile and it’s adding more cool stuff.
- option_spec = {'align': <function ImageDirective.align>, 'alt': <function unchanged>, 'class': <function class_option>, 'download': <function directive_boolean>, 'group': <function unchanged>, 'height': <function length_or_unitless>, 'legacy_class': <function class_option>, 'show_caption': <function directive_boolean>, 'strech': <function choice>, 'target': <function unchanged>, 'title': <function unchanged>, 'width': <function length_or_percentage_or_unitless>}[source]¶
Mapping of option names to validator functions.
- pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.configure_backend(app)[source]¶
local function
- pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.directive_boolean(value)[source]¶
local function
- pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.download_images(app, env)[source]¶
Downloads images before running the documentation.
- Parameters:
app – Sphinx application
env – environment
- class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.gallery_node(rawsource='', *children, **attributes)[source]¶
Bases:
image
,General
,Element
sphinx node
- pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.get_image_extension(uri)[source]¶
Guesses an extension for an image.
- class pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.image_node(rawsource='', *children, **attributes)[source]¶
Bases:
image
,General
,Element
sphinx node
- pyquickhelper.sphinxext.sphinximages.sphinxtrib.images.install_backend_static_files(app, env)[source]¶
local function