Documentation nodes
Node | Docstrings | Markdown extensions |
---|---|---|
MkClassDiagram | Node to display the class hierarchy of a class. Supports multiple modes. | pymdownx.superfences |
MkDocStrings | Docstring section (powered by mkdocstrings). | |
MkCommentedCode | Node which displays a list of code / comment blocks for given code. Lines beginning with # are shown in dedicated blocks and can be used to inline-explain the code. Lines can be hidden by ending a line with "##". |
|
MkConfigSetting | Node for describing a config setting. | |
MkClassTable | Node for a table showing info for a list of classes. | tables |
MkModuleTable | Node for a table containing formatted information about a module. | tables |
MkPluginFlow | Node showing info about the different stages of an MkDocs plugin. | |
MkCliDoc | Node for showing documentation for click / typer CLI apps. |
Page info
Code for this section
Resources
Resources(css=[],
markdown_extensions={'attr_list': {},
'md_in_html': {},
'pymdownx.emoji': {'emoji_generator': <function to_svg at 0x7fd7a6931800>,
'emoji_index': <function twemoji at 0x7fd7a69316c0>},
'pymdownx.magiclink': {'repo': 'mknodes',
'repo_url_shorthand': True,
'user': 'phil65'},
'tables': {}},
plugins=[],
js=[],
assets=[],
packages=[])