This page was autogenerated. Run devil/bin/generate_md_docs to update
A really bare-bones argparse help formatter that generates valid markdown.
This will generate something like:
usage
# **section heading**:
## **--argument-one**
\`\`\`
argument-one help text
\`\`\`
Adds --md-help to the given argparse.ArgumentParser.
Running a script with --md-help will print the help text for that script
as valid markdown.
Args:
parser: The ArgumentParser to which --md-help should be added.
Load a module given only the path name.
Also loads package modules as necessary.
Args:
module_path: An absolute path to a python module.
Returns:
The module object for the given path.
Write markdown documentation for the module at the provided path.
Args:
raw_args: the raw command-line args. Usually sys.argv[1:].
Returns:
An integer exit code. 0 for success, non-zero for failure.
Returns markdown-formatted bold text.
Write markdown documentation for a class.
Documents public methods. Does not currently document subclasses.
Args:
class_obj: a types.TypeType object for the class that should be
documented.
Returns:
A list of markdown-formatted lines.
Returns a markdown-formatted code block in the given language.
Write a markdown-formatted docstring.
Returns:
A list of markdown-formatted lines.
Escapes * and _.
Write markdown documentation for a function.
Args:
func_obj: a types.FunctionType object for the function that should be
documented.
Returns:
A list of markdown-formatted lines.
Returns markdown-formatted heading.
Returns markdown-formatted inline code.
Returns markdown-formatted italic text.
returns a markdown-formatted link.
Write markdown documentation for a module.
Documents public classes and functions.
Args:
module_obj: a module object that should be documented.
Returns:
A list of markdown-formatted lines.