module sphinxext.sphinx_video_extension
¶
Short summary¶
module pyquickhelper.sphinxext.sphinx_video_extension
Defines a sphinx extension to add button to share a page
Classes¶
class |
truncated documentation |
---|---|
Defines video node. |
|
Adds video to a page. It can be done by adding |
Functions¶
function |
truncated documentation |
---|---|
What to do when leaving a node video the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node video the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node video the function should have different behaviour, depending on the format, or … |
|
What to do when leaving a node video the function should have different behaviour, depending on the format, or … |
|
Initializes the video directives. |
|
setup for |
|
Visits a video node. Copies the video. |
Properties¶
property |
truncated documentation |
---|---|
|
Return the document root node of the tree containing this Node. |
Methods¶
method |
truncated documentation |
---|---|
Runs the directive. |
Documentation¶
Defines a sphinx extension to add button to share a page
- class pyquickhelper.sphinxext.sphinx_video_extension.VideoDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶
Bases:
Directive
Adds video to a page. It can be done by adding:
.. video:: filename.mp4 :width: 400 :height: 600
For latex, unit becomes pt. See latex units. Videos are not enabled on latex by default, option
:latex:
must be set up.- option_spec = {'height': <function unchanged>, 'latex': <function unchanged>, 'width': <function unchanged>}[source]¶
Mapping of option names to validator functions.
- video_class[source]¶
alias of
video_node
- pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_html(self, node)[source]¶
What to do when leaving a node video the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
- pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_latex(self, node)[source]¶
What to do when leaving a node video the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
- pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_rst(self, node)[source]¶
What to do when leaving a node video the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
- pyquickhelper.sphinxext.sphinx_video_extension.depart_video_node_text(self, node)[source]¶
What to do when leaving a node video the function should have different behaviour, depending on the format, or the setup should specify a different function for each.
- pyquickhelper.sphinxext.sphinx_video_extension.initialize_videos_directive(app)[source]¶
Initializes the video directives.
- class pyquickhelper.sphinxext.sphinx_video_extension.video_node(rawsource='', *children, **attributes)[source]¶
Bases:
General
,Element
Defines video node.