extension ¤
This module holds the code of the Markdown extension responsible for matching "autodoc" instructions.
The extension is composed of a Markdown block processor that matches indented blocks starting with a line like identifier
.
For each of these blocks, it uses a handler to collect documentation about the given identifier and render it with Jinja templates.
Both the collection and rendering process can be configured by adding YAML configuration under the "autodoc" instruction:
::: some.identifier
handler: python
options:
option1: value1
option2:
- value2a
- value2b
option_x: etc
Classes:
-
AutoDocProcessor
–Our "autodoc" Markdown block processor.
-
MkdocstringsExtension
–Our Markdown extension.
AutoDocProcessor ¤
AutoDocProcessor(
parser: BlockParser,
md: Markdown,
config: dict,
handlers: Handlers,
autorefs: AutorefsPlugin,
)
Bases: BlockProcessor
Our "autodoc" Markdown block processor.
It has a test
method that tells if a block matches a criterion, and a run
method that processes it.
It also has utility methods allowing to get handlers and their configuration easily, useful when processing a matched block.
Parameters:
-
parser
¤BlockParser
) –A
markdown.blockparser.BlockParser
instance. -
md
¤Markdown
) –A
markdown.Markdown
instance. -
config
¤dict
) –The configuration of the
mkdocstrings
plugin. -
handlers
¤Handlers
) –The handlers container.
-
autorefs
¤AutorefsPlugin
) –The autorefs plugin instance.
Methods:
Source code in src/mkdocstrings/extension.py
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
run ¤
run(parent: Element, blocks: MutableSequence[str]) -> None
Run code on the matched blocks.
The identifier and configuration lines are retrieved from a matched block and used to collect and render an object.
Parameters:
-
parent
¤Element
) –The parent element in the XML tree.
-
blocks
¤MutableSequence[str]
) –The rest of the blocks to be processed.
Source code in src/mkdocstrings/extension.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
|
test ¤
Match our autodoc instructions.
Parameters:
Returns:
-
bool
–Whether this block should be processed or not.
Source code in src/mkdocstrings/extension.py
86 87 88 89 90 91 92 93 94 95 96 |
|
MkdocstringsExtension ¤
Bases: Extension
Our Markdown extension.
It cannot work outside of mkdocstrings
.
Parameters:
-
config
¤dict
) –The configuration items from
mkdocs
andmkdocstrings
that must be passed to the block processor when instantiated inextendMarkdown
. -
handlers
¤Handlers
) –The handlers container.
-
autorefs
¤AutorefsPlugin
) –The autorefs plugin instance.
-
**kwargs
¤Any
, default:{}
) –Keyword arguments used by
markdown.extensions.Extension
.
Methods:
-
extendMarkdown
–Register the extension.
Source code in src/mkdocstrings/extension.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
extendMarkdown ¤
extendMarkdown(md: Markdown) -> None
Register the extension.
Add an instance of our AutoDocProcessor
to the Markdown parser.
Parameters:
-
md
¤Markdown
) –A
markdown.Markdown
instance.
Source code in src/mkdocstrings/extension.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
|