ModuleTocTree

class documenteer.ext.packagetoctree.ModuleTocTree(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Directive

Toctree that automatically displays a list of modules in the Stack documentation.

Notes

Modules are detected as document paths. All modules have index pages with paths modules/{{name}}/index by virtue of the linking during the build process. Thus this directive does not directly interact with eups.

Options

skip

Module (or modules) to skip (optional). For multiple modules, provide a comma-delimited list. If possible, use the -s option from the stack-docs command-line app instead to prevent orphan document issues.

Attributes Summary

has_content	May the directive have content?
option_spec	Mapping of option names to validator functions.

Methods Summary

run()

Main entrypoint method.

Attributes Documentation

has_content = False

May the directive have content?

option_spec = {'skip': <function unchanged>}

Mapping of option names to validator functions.

Methods Documentation

run()

Main entrypoint method.

Returns:

new_nodes – Nodes to add to the doctree.

Return type:

list