jetblack_markdown.autodoc
module jetblack_markdown.autodoc
Summary
A markdown extension for creating documentation
function jetblack_markdown.makeExtension
Summary
Make the extension
Description
This hook function gets picked up by the markdown processor when the extension is listed
python
output = markdown.markdown(
content, extensions=[
"admonition",
"codehilite",
"jetblack_markdown.autodoc",
])
print(output)
jetblack_markdown.makeExtension(
*args,
**kwargs
) -> ExtensionParameters
*args **kwargsReturns
Extension: The markdown extensionclass AutodocExtension(Extension)
Summary
Initiate Extension and set up configs.
jetblack_markdown.autodoc.AutodocExtension(
*args,
**kwargs
) -> NoneParameters
*args **kwargsmethod AutodocExtension.extendMarkdown
Summary
Add the various processors and patterns to the Markdown Instance.
Description
This method must be overridden by every extension.
AutodocExtension.extendMarkdown(
md: Markdown
) -> NoneParameters
md: MarkdownThe Markdown instance.