module sphinxext.sphinx_youtube_extension

Short summary

module pyquickhelper.sphinxext.sphinx_youtube_extension

Inspired from sphinxcontrib.youtube (not maintained anymore).

source on GitHub

Classes

class	truncated documentation
youtube_node	Youtube node.
YoutubeDirective	Youtube directive.

Functions

function	truncated documentation
css	Returns style.
depart_youtube_node	Youtube node.
get_size	Get size.
setup	Setup for youtube extension.
visit_youtube_node	Visit youtube node (html).

Properties

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

Methods

method	truncated documentation
run

Documentation

Inspired from sphinxcontrib.youtube (not maintained anymore).

source on GitHub

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

Bases: Directive

Youtube directive.

source on GitHub

final_argument_whitespace = False

May the final argument contain whitespace?

has_content = True

May the directive have content?

option_spec = {'aspect': <function unchanged>, 'height': <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 = 1

Number of required directive arguments.

pyquickhelper.sphinxext.sphinx_youtube_extension.css(d)

Returns style.

source on GitHub

pyquickhelper.sphinxext.sphinx_youtube_extension.depart_youtube_node(self, node)

Youtube node.

source on GitHub

pyquickhelper.sphinxext.sphinx_youtube_extension.get_size(d, key)

Get size.

Parameters:

• d – string

• key – string

Returns:

integer

source on GitHub

pyquickhelper.sphinxext.sphinx_youtube_extension.setup(app)

Setup for youtube extension.

source on GitHub

pyquickhelper.sphinxext.sphinx_youtube_extension.visit_youtube_node(self, node)

Visit youtube node (html).

source on GitHub

class pyquickhelper.sphinxext.sphinx_youtube_extension.youtube_node(rawsource='', *children, **attributes)

Bases: General, Element

Youtube node.

source on GitHub