@@ -8,13 +8,13 @@ Main module for markdown generation.
8
8
9
9
---
10
10
11
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L181 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
11
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L183 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
12
12
13
13
## <kbd >function</kbd > ` to_md_file `
14
14
15
15
``` python
16
16
to_md_file(
17
- string : str ,
17
+ markdown_str : str ,
18
18
filename: str ,
19
19
out_path: str = ' ' ,
20
20
watermark: bool = True ,
@@ -28,7 +28,7 @@ Creates an API docs file from a provided text.
28
28
29
29
** Args:**
30
30
31
- - <b >` string ` </b > (str): String with line breaks to write to file.
31
+ - <b >` markdown_str ` </b > (str): Markdown string with line breaks to write to file.
32
32
- <b >` filename ` </b > (str): Filename without the .md
33
33
- <b >` watermark ` </b > (bool): If ` True ` , add a watermark with a timestamp to bottom of the markdown files.
34
34
- <b >` disable_markdownlint ` </b > (bool): If ` True ` , an inline tag is added to disable markdownlint for this file.
@@ -37,7 +37,7 @@ Creates an API docs file from a provided text.
37
37
38
38
---
39
39
40
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L821 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
40
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L856 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
41
41
42
42
## <kbd >function</kbd > ` generate_docs `
43
43
@@ -74,12 +74,12 @@ Generates markdown documentation for provided paths based on Google-style docstr
74
74
75
75
---
76
76
77
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L402 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
77
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L421 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
78
78
79
79
## <kbd >class</kbd > ` MarkdownGenerator `
80
80
Markdown generator class.
81
81
82
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L405 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
82
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L424 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
83
83
84
84
### <kbd >method</kbd > ` __init__ `
85
85
@@ -106,7 +106,7 @@ Initializes the markdown API generator.
106
106
107
107
---
108
108
109
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L553 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
109
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L576 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
110
110
111
111
### <kbd >method</kbd > ` class2md `
112
112
@@ -131,7 +131,7 @@ Takes a class and creates markdown text to document its methods and variables.
131
131
132
132
---
133
133
134
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L472 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
134
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L491 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
135
135
136
136
### <kbd >method</kbd > ` func2md `
137
137
@@ -157,7 +157,7 @@ Takes a function (or method) and generates markdown docs.
157
157
158
158
---
159
159
160
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L747 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
160
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L782 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
161
161
162
162
### <kbd >method</kbd > ` import2md `
163
163
@@ -182,7 +182,7 @@ Generates markdown documentation for a selected object/import.
182
182
183
183
---
184
184
185
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L660 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
185
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L687 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
186
186
187
187
### <kbd >method</kbd > ` module2md `
188
188
@@ -207,7 +207,7 @@ Takes an imported module object and create a Markdown string containing function
207
207
208
208
---
209
209
210
- <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L767 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
210
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L802 " ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
211
211
212
212
### <kbd >method</kbd > ` overview2md `
213
213
0 commit comments