`skeleton`#

The init file of the extension.

This is where the extension is loaded and the sphinx builder is extended.

Submodules#

Package Contents#

Classes#

`DemoDirective`	A demo directive simply setting the text in bold.
`DemoRole`	The demo sphinxrole interpreter.
`demo_node`	The demo node.

Functions#

setup(app)

Add icon node to the sphinx builder.

Attributes#

`_NODE_VISITORS`
`__author__`
`__email__`
`__version__`

class skeleton.DemoDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]#

Bases: sphinx.util.docutils.SphinxDirective

A demo directive simply setting the text in bold.

arguments = 1#

final_argument_whitespace = False#

has_content = True#

run()[source]#

Create the demo directive output.

Return type:: List[docutils.nodes.Node]

class skeleton.DemoRole[source]#

Bases: sphinx.util.docutils.SphinxRole

The demo sphinxrole interpreter.

run()[source]#

Setup the role in the builder context.

Return type:: Tuple[List[docutils.nodes.Node], List[str]]

class skeleton.demo_node(rawsource='', *children, **attributes)[source]#

Bases: docutils.nodes.General, docutils.nodes.Element

The demo node.

skeleton.setup(app)[source]#