Compilers

docstr_md.python.compilers.Sklearn

Compiles sklearn-style markdown.

Examples

from docstr_md.python import PySoup, compilers

# replace with the appropriate file path and parser
soup = PySoup(path='path/to/file.py', parser='sklearn')
compiler = compilers.Sklearn()
md = compiler(soup)

md is a string of compiled markdown.

Methods

__call__(self, soup) [source]

Compile markdown from soup.

Parameters:	soup : docstr_md.python.PySoup Soup to be compiled into markdown.
Returns:	md : str Compiled markdown.