module sphinxext.sphinx_image_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_image_extension
Defines a sphinx extension to add button to share a page
Classes¶
class |
truncated documentation |
---|---|
Defines image node. |
|
Adds an image to a page. It can be done by adding |
Functions¶
function |
truncated documentation |
---|---|
What to do when leaving a node image the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node image the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node image the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node image the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node image the function should have different behaviour, depending on the format, or … |
|
Initializes the image directives. |
|
setup for |
|
Visits a image node. Copies the image. |
Documentation¶
Defines a sphinx extension to add button to share a page
-
class
pyquickhelper.sphinxext.sphinx_image_extension.
SimpleImageDirective
(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶ Bases:
docutils.parsers.rst.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
-
node_class
[source]¶ alias of
pyquickhelper.sphinxext.sphinx_image_extension.simpleimage_node
-
pyquickhelper.sphinxext.sphinx_image_extension.
depart_simpleimage_node_html
(self, node)[source]¶ 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.
-
pyquickhelper.sphinxext.sphinx_image_extension.
depart_simpleimage_node_latex
(self, node)[source]¶ 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.
-
pyquickhelper.sphinxext.sphinx_image_extension.
depart_simpleimage_node_md
(self, node)[source]¶ 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.
-
pyquickhelper.sphinxext.sphinx_image_extension.
depart_simpleimage_node_rst
(self, node)[source]¶ 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.
-
pyquickhelper.sphinxext.sphinx_image_extension.
depart_simpleimage_node_text
(self, node)[source]¶ 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.
-
pyquickhelper.sphinxext.sphinx_image_extension.
initialize_simpleimages_directive
(app)[source]¶ Initializes the image directives.
-
class
pyquickhelper.sphinxext.sphinx_image_extension.
simpleimage_node
(rawsource='', *children, **attributes)[source]¶ Bases:
docutils.nodes.General
,docutils.nodes.Element
Defines image node.