@@ -7,7 +7,7 @@ Main module for markdown generation.
7
7
8
8
---
9
9
10
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L177 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
10
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L182 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
11
11
12
12
## <kbd >function</kbd > ` to_md_file `
13
13
@@ -34,7 +34,7 @@ Creates an API docs file from a provided text.
34
34
35
35
---
36
36
37
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L788 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
37
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L793 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
38
38
39
39
## <kbd >function</kbd > ` generate_docs `
40
40
@@ -71,13 +71,13 @@ Generates markdown documentation for provided paths based on Google-style docstr
71
71
72
72
---
73
73
74
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L252 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
74
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L257 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
75
75
76
76
## <kbd >class</kbd > ` MarkdownGenerator `
77
77
Markdown generator class.
78
78
79
79
80
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L255 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
80
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L260 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
81
81
82
82
### <kbd >method</kbd > ` __init__ `
83
83
@@ -103,7 +103,7 @@ Initializes the markdown API generator.
103
103
104
104
---
105
105
106
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L540 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
106
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L545 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
107
107
108
108
### <kbd >method</kbd > ` class2md `
109
109
@@ -128,7 +128,7 @@ Takes a class and creates markdown text to document its methods and variables.
128
128
129
129
---
130
130
131
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L344 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
131
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L349 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
132
132
133
133
### <kbd >method</kbd > ` doc2md `
134
134
@@ -152,7 +152,7 @@ Parse docstring (with getdoc) according to Google-style formatting and convert t
152
152
153
153
---
154
154
155
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L458 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
155
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L463 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
156
156
157
157
### <kbd >method</kbd > ` func2md `
158
158
@@ -178,7 +178,7 @@ Takes a function (or method) and generates markdown docs.
178
178
179
179
---
180
180
181
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L721 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
181
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L726 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
182
182
183
183
### <kbd >method</kbd > ` import2md `
184
184
@@ -203,7 +203,7 @@ Generates markdown documentation for a selected object/import.
203
203
204
204
---
205
205
206
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L634 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
206
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L639 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
207
207
208
208
### <kbd >method</kbd > ` module2md `
209
209
@@ -228,7 +228,7 @@ Takes an imported module object and create a Markdown string containing function
228
228
229
229
---
230
230
231
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L741 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
231
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L746 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
232
232
233
233
### <kbd >method</kbd > ` overview2md `
234
234
0 commit comments