1*1fa4b3daSHector Dearman# [devil.utils.markdown](https://chromium.googlesource.com/catapult.git/+/HEAD/devil/devil/utils/markdown.py) 2*1fa4b3daSHector Dearman 3*1fa4b3daSHector Dearman*This page was autogenerated. Run `devil/bin/generate_md_docs` to update* 4*1fa4b3daSHector Dearman 5*1fa4b3daSHector Dearman## MarkdownHelpAction 6*1fa4b3daSHector Dearman 7*1fa4b3daSHector Dearman### MarkdownHelpAction.\_\_call\_\_ 8*1fa4b3daSHector Dearman 9*1fa4b3daSHector Dearman### MarkdownHelpAction.\_\_init\_\_ 10*1fa4b3daSHector Dearman 11*1fa4b3daSHector Dearman## MarkdownHelpFormatter 12*1fa4b3daSHector Dearman 13*1fa4b3daSHector DearmanA really bare-bones argparse help formatter that generates valid markdown. 14*1fa4b3daSHector Dearman``` 15*1fa4b3daSHector Dearman This will generate something like: 16*1fa4b3daSHector Dearman 17*1fa4b3daSHector Dearman usage 18*1fa4b3daSHector Dearman 19*1fa4b3daSHector Dearman # **section heading**: 20*1fa4b3daSHector Dearman 21*1fa4b3daSHector Dearman ## **--argument-one** 22*1fa4b3daSHector Dearman 23*1fa4b3daSHector Dearman \`\`\` 24*1fa4b3daSHector Dearman argument-one help text 25*1fa4b3daSHector Dearman \`\`\` 26*1fa4b3daSHector Dearman 27*1fa4b3daSHector Dearman``` 28*1fa4b3daSHector Dearman 29*1fa4b3daSHector Dearman 30*1fa4b3daSHector Dearman### MarkdownHelpFormatter.format\_help 31*1fa4b3daSHector Dearman 32*1fa4b3daSHector Dearman### MarkdownHelpFormatter.start\_section 33*1fa4b3daSHector Dearman 34*1fa4b3daSHector Dearman### add\_md\_help\_argument 35*1fa4b3daSHector Dearman 36*1fa4b3daSHector DearmanAdds --md-help to the given argparse.ArgumentParser. 37*1fa4b3daSHector Dearman``` 38*1fa4b3daSHector Dearman Running a script with --md-help will print the help text for that script 39*1fa4b3daSHector Dearman as valid markdown. 40*1fa4b3daSHector Dearman 41*1fa4b3daSHector Dearman Args: 42*1fa4b3daSHector Dearman parser: The ArgumentParser to which --md-help should be added. 43*1fa4b3daSHector Dearman``` 44*1fa4b3daSHector Dearman 45*1fa4b3daSHector Dearman 46*1fa4b3daSHector Dearman### load\_module\_from\_path 47*1fa4b3daSHector Dearman 48*1fa4b3daSHector DearmanLoad a module given only the path name. 49*1fa4b3daSHector Dearman``` 50*1fa4b3daSHector Dearman Also loads package modules as necessary. 51*1fa4b3daSHector Dearman 52*1fa4b3daSHector Dearman Args: 53*1fa4b3daSHector Dearman module_path: An absolute path to a python module. 54*1fa4b3daSHector Dearman Returns: 55*1fa4b3daSHector Dearman The module object for the given path. 56*1fa4b3daSHector Dearman``` 57*1fa4b3daSHector Dearman 58*1fa4b3daSHector Dearman 59*1fa4b3daSHector Dearman### main 60*1fa4b3daSHector Dearman 61*1fa4b3daSHector DearmanWrite markdown documentation for the module at the provided path. 62*1fa4b3daSHector Dearman``` 63*1fa4b3daSHector Dearman Args: 64*1fa4b3daSHector Dearman raw_args: the raw command-line args. Usually sys.argv[1:]. 65*1fa4b3daSHector Dearman Returns: 66*1fa4b3daSHector Dearman An integer exit code. 0 for success, non-zero for failure. 67*1fa4b3daSHector Dearman``` 68*1fa4b3daSHector Dearman 69*1fa4b3daSHector Dearman 70*1fa4b3daSHector Dearman### md\_bold 71*1fa4b3daSHector Dearman 72*1fa4b3daSHector DearmanReturns markdown-formatted bold text. 73*1fa4b3daSHector Dearman### md\_class 74*1fa4b3daSHector Dearman 75*1fa4b3daSHector DearmanWrite markdown documentation for a class. 76*1fa4b3daSHector Dearman``` 77*1fa4b3daSHector Dearman Documents public methods. Does not currently document subclasses. 78*1fa4b3daSHector Dearman 79*1fa4b3daSHector Dearman Args: 80*1fa4b3daSHector Dearman class_obj: a types.TypeType object for the class that should be 81*1fa4b3daSHector Dearman documented. 82*1fa4b3daSHector Dearman Returns: 83*1fa4b3daSHector Dearman A list of markdown-formatted lines. 84*1fa4b3daSHector Dearman``` 85*1fa4b3daSHector Dearman 86*1fa4b3daSHector Dearman 87*1fa4b3daSHector Dearman### md\_code 88*1fa4b3daSHector Dearman 89*1fa4b3daSHector DearmanReturns a markdown-formatted code block in the given language. 90*1fa4b3daSHector Dearman### md\_docstring 91*1fa4b3daSHector Dearman 92*1fa4b3daSHector DearmanWrite a markdown-formatted docstring. 93*1fa4b3daSHector Dearman``` 94*1fa4b3daSHector Dearman Returns: 95*1fa4b3daSHector Dearman A list of markdown-formatted lines. 96*1fa4b3daSHector Dearman``` 97*1fa4b3daSHector Dearman 98*1fa4b3daSHector Dearman 99*1fa4b3daSHector Dearman### md\_escape 100*1fa4b3daSHector Dearman 101*1fa4b3daSHector DearmanEscapes \* and \_. 102*1fa4b3daSHector Dearman### md\_function 103*1fa4b3daSHector Dearman 104*1fa4b3daSHector DearmanWrite markdown documentation for a function. 105*1fa4b3daSHector Dearman``` 106*1fa4b3daSHector Dearman Args: 107*1fa4b3daSHector Dearman func_obj: a types.FunctionType object for the function that should be 108*1fa4b3daSHector Dearman documented. 109*1fa4b3daSHector Dearman Returns: 110*1fa4b3daSHector Dearman A list of markdown-formatted lines. 111*1fa4b3daSHector Dearman``` 112*1fa4b3daSHector Dearman 113*1fa4b3daSHector Dearman 114*1fa4b3daSHector Dearman### md\_heading 115*1fa4b3daSHector Dearman 116*1fa4b3daSHector DearmanReturns markdown-formatted heading. 117*1fa4b3daSHector Dearman### md\_inline\_code 118*1fa4b3daSHector Dearman 119*1fa4b3daSHector DearmanReturns markdown-formatted inline code. 120*1fa4b3daSHector Dearman### md\_italic 121*1fa4b3daSHector Dearman 122*1fa4b3daSHector DearmanReturns markdown-formatted italic text. 123*1fa4b3daSHector Dearman### md\_link 124*1fa4b3daSHector Dearman 125*1fa4b3daSHector Dearmanreturns a markdown-formatted link. 126*1fa4b3daSHector Dearman### md\_module 127*1fa4b3daSHector Dearman 128*1fa4b3daSHector DearmanWrite markdown documentation for a module. 129*1fa4b3daSHector Dearman``` 130*1fa4b3daSHector Dearman Documents public classes and functions. 131*1fa4b3daSHector Dearman 132*1fa4b3daSHector Dearman Args: 133*1fa4b3daSHector Dearman module_obj: a module object that should be documented. 134*1fa4b3daSHector Dearman Returns: 135*1fa4b3daSHector Dearman A list of markdown-formatted lines. 136*1fa4b3daSHector Dearman``` 137*1fa4b3daSHector Dearman 138*1fa4b3daSHector Dearman 139