devil.utils.markdown

This page was autogenerated. Run devil/bin/generate_md_docs to update

MarkdownHelpAction

MarkdownHelpAction.__call__

MarkdownHelpAction.__init__

MarkdownHelpFormatter

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
  \`\`\`

MarkdownHelpFormatter.format_help

MarkdownHelpFormatter.start_section

add_md_help_argument

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_module_from_path

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.

main

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.

md_bold

Returns markdown-formatted bold text.

md_class

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.

md_code

Returns a markdown-formatted code block in the given language.

md_docstring

Write a markdown-formatted docstring.

  Returns:
    A list of markdown-formatted lines.

md_escape

Escapes * and _.

md_function

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.

md_heading

Returns markdown-formatted heading.

md_inline_code

Returns markdown-formatted inline code.

md_italic

Returns markdown-formatted italic text.

md_link

returns a markdown-formatted link.

md_module

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.