pymdgen.md

Classes


Extension

Extension(markdown.extensions.Extension)

Base class for extensions to subclass.

Methods

extendMarkdown

def extendMarkdown(self, md)

Add the various proccesors and patterns to the Markdown Instance.

This method must be overriden by every extension.

Keyword arguments:

  • md: The Markdown instance.

  • md_globals: Global variables in the markdown module namespace.


GenCodeDocs

GenCodeDocs(markdown.preprocessors.Preprocessor)

output code docs for specified python module

Methods

run

def run(self, lines)

Each subclass of Preprocessor should override the run method, which takes the document as a list of strings split by newlines and returns the (possibly modified) list of lines.


GenCommandOutput

GenCommandOutput(markdown.preprocessors.Preprocessor)

render command output

Methods

run

def run(self, lines)

Each subclass of Preprocessor should override the run method, which takes the document as a list of strings split by newlines and returns the (possibly modified) list of lines.