oembedpy.adapters.sphinx module

Sphinx extension module.

class oembedpy.adapters.sphinx.OembedDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Directive

has_content = False

May the directive have content?

option_spec = {'maxheight': <function positive_int>, 'maxwidth': <function positive_int>}

Mapping of option names to validator functions.

required_arguments = 1

Number of required directive arguments.

run()

class oembedpy.adapters.sphinx.OembedDomain(env: BuildEnvironment)

Bases: Domain

property caches: dict[Tuple[str, int | None, int | None], Photo | Video | Link | Rich | HtmlOnly]

has_cache(key: Tuple[str, int | None, int | None]) → bool

label = 'oembedpy'

domain label: longer, more descriptive (used in messages)

name = 'oembedpy.adapters.sphinx'

domain name: should be short, but unique

process_doc(env: BuildEnvironment, docname: str, document: document)

Process a document after it is read by the environment.

oembedpy.adapters.sphinx.depart_oembed_node(self, node)

class oembedpy.adapters.sphinx.oembed(rawsource='', *children, **attributes)

Bases: General, Element

oembedpy.adapters.sphinx.setup(app: Sphinx)

oembedpy.adapters.sphinx.visit_oembed_node(self, node)