blob: 957dba7d982b9ebf901a62af574d75f801bc46bc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
# [devil.utils.markdown](https://github.com/catapult-project/catapult/blob/master/devil/devil/utils/markdown.py)
*This page was autogenerated by `devil/utils/markdown.py --module-link https://github.com/catapult-project/catapult/blob/master/devil/devil/utils/markdown.py`*
## MarkdownHelpAction
### MarkdownHelpAction.\_\_init\_\_
### MarkdownHelpAction.\_\_call\_\_
## 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
### md\_bold
Returns markdown-formatted bold text.
### md\_code
Returns a markdown-formatted code block in the given language.
### md\_escape
Escapes \* and \_.
### 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.
### 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.
```
### md\_module
Write markdown documentation for a class.
```
Documents public classes and functions.
Args:
class_obj: a types.TypeType object for the class that should be
documented.
Returns:
A list of markdown-formatted lines.
```
### 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\_docstring
Write a markdown-formatted docstring.
```
Returns:
A list of markdown-formatted lines.
```
### 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.
```
### 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.
```
|
