skeleton.demo_directive

Demonstration of a custom directive for sphinx.

This directive should be deleted when starting a new extension but it gives an overview of the different steps to follow to create a new directive. It is also used to demonstrate the documentation/test workflows.

Note

We only coded a html output for this directive.

Module Contents

Classes

DemoDirective

A demo directive simply setting the text in bold.

Attributes

logger

class skeleton.demo_directive.DemoDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: sphinx.util.docutils.SphinxDirective

A demo directive simply setting the text in bold.

arguments = 1

final_argument_whitespace = False

has_content = True

run()

Create the demo directive output.

Return type:

List[docutils.nodes.Node]

skeleton.demo_directive.logger