linuxdoc.kernel_include module

kernel-include

Implementation of the kernel-include reST-directive.

copyright:

Copyright (C) 2018 Markus Heiser

license:

AGPL-3.0-or-later; see LICENSE for details.

For user documentation see Use kernel-include in reST documents.

class linuxdoc.kernel_include.KernelInclude(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: Include

KernelInclude (kernel-include) directive

run()

Include a file as part of the content of this reST file.

Depending on the options, the file (or a clipping) is converted to nodes and returned or inserted into the input stream.

linuxdoc.kernel_include.setup(app)