module sphinxext.sphinx_image_extension

Short summary

module pyquickhelper.sphinxext.sphinx_image_extension

Defines a sphinx extension to add button to share a page

source on GitHub

Classes

class	truncated documentation
simpleimage_node	Defines image node.
SimpleImageDirective	Adds an image to a page. It can be done by adding

Functions

function	truncated documentation
_clean_value
depart_simpleimage_node_html	What to do when leaving a node image the function should have different behaviour, depending on the format, or …
depart_simpleimage_node_latex	What to do when leaving a node image the function should have different behaviour, depending on the format, or …
depart_simpleimage_node_md	What to do when leaving a node image the function should have different behaviour, depending on the format, or …
depart_simpleimage_node_rst	What to do when leaving a node image the function should have different behaviour, depending on the format, or …
depart_simpleimage_node_text	What to do when leaving a node image the function should have different behaviour, depending on the format, or …
initialize_simpleimages_directive	Initializes the image directives.
setup	setup for image (sphinx)
visit_simpleimage_node	Visits a image node. Copies the image.

Properties

property	truncated documentation
document	Return the document node at the root of the tree containing this Node.

Methods

method	truncated documentation
run	Runs the directive.

Documentation

Defines a sphinx extension to add button to share a page

source on GitHub

class pyquickhelper.sphinxext.sphinx_image_extension.SimpleImageDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Directive

Adds an image to a page. It can be done by adding:

.. simpleimage:: filename.png
    :width: 400
    :height: 600

Available options:

• :width:, :height:, :scale:: resize the image

• :target:: for HTML, clickable image

• :alt:: for HTML

• :download: if the image is a url, it downloads the image.

• :convert: convert the image into a new format

source on GitHub

final_argument_whitespace = True

May the final argument contain whitespace?

has_content = True

May the directive have content?

node_class

alias of simpleimage_node

option_spec = {'alt': <function unchanged>, 'convert': <function unchanged>, 'download': <function unchanged>, 'height': <function unchanged>, 'scale': <function unchanged>, 'target': <function unchanged>, 'width': <function unchanged>}

Mapping of option names to validator functions.

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = True

Number of required directive arguments.

run()

Runs the directive.

Returns

a list of nodes

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension._clean_value(val)

pyquickhelper.sphinxext.sphinx_image_extension.depart_simpleimage_node_html(self, node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.depart_simpleimage_node_latex(self, node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.depart_simpleimage_node_md(self, node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.depart_simpleimage_node_rst(self, node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.depart_simpleimage_node_text(self, node)

What to do when leaving a node image the function should have different behaviour, depending on the format, or the setup should specify a different function for each.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.initialize_simpleimages_directive(app)

Initializes the image directives.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.setup(app)

setup for image (sphinx)

source on GitHub

class pyquickhelper.sphinxext.sphinx_image_extension.simpleimage_node(rawsource='', *children, **attributes)

Bases: General, Element

Defines image node.

source on GitHub

pyquickhelper.sphinxext.sphinx_image_extension.visit_simpleimage_node(self, node)

Visits a image node. Copies the image.

source on GitHub