1
1
2
- <a href =" .. /src/lazydocs/generation.py#L0" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
2
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L0" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
3
3
4
4
# <kbd >module</kbd > ` lazydocs.generation `
5
5
Main module for markdown generation.
6
6
7
7
8
8
---
9
9
10
- <a href =" .. /src/lazydocs/generation.py#L172" ><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#L172" ><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
@@ -37,7 +37,7 @@ Creates an API docs file from a provided text.
37
37
38
38
---
39
39
40
- <a href =" .. /src/lazydocs/generation.py#L751" ><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#L751" ><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
@@ -82,14 +82,14 @@ Generates markdown documentation for provided paths based on Google-style docstr
82
82
83
83
---
84
84
85
- <a href =" .. /src/lazydocs/generation.py#L247" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
85
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L247" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
86
86
87
87
## <kbd >class</kbd > ` MarkdownGenerator `
88
88
Markdown generator class.
89
89
90
90
91
91
92
- <a href =" .. /src/lazydocs/generation.py#L250" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
92
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L250" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
93
93
94
94
### <kbd >method</kbd > ` __init__ `
95
95
@@ -118,7 +118,7 @@ Initializes the markdown API generator.
118
118
119
119
---
120
120
121
- <a href =" .. /src/lazydocs/generation.py#L514" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
121
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L514" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
122
122
123
123
### <kbd >method</kbd > ` class2md `
124
124
@@ -144,7 +144,7 @@ Takes a class and creates markdown text to document its methods and variables.
144
144
145
145
---
146
146
147
- <a href =" .. /src/lazydocs/generation.py#L339" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
147
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L339" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
148
148
149
149
### <kbd >method</kbd > ` doc2md `
150
150
@@ -168,7 +168,7 @@ Parse docstring (with getdoc) according to Google-style formatting and convert t
168
168
169
169
---
170
170
171
- <a href =" .. /src/lazydocs/generation.py#L434" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
171
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L434" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
172
172
173
173
### <kbd >method</kbd > ` func2md `
174
174
@@ -196,7 +196,7 @@ Takes a function (or method) and generates markdown docs.
196
196
197
197
---
198
198
199
- <a href =" .. /src/lazydocs/generation.py#L688" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
199
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L688" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
200
200
201
201
### <kbd >method</kbd > ` import2md `
202
202
@@ -222,7 +222,7 @@ Generates markdown documentation for a selected object/import.
222
222
223
223
---
224
224
225
- <a href =" .. /src/lazydocs/generation.py#L601" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
225
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L601" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
226
226
227
227
### <kbd >method</kbd > ` module2md `
228
228
@@ -248,7 +248,7 @@ Takes an imported module object and create a Markdown string containing function
248
248
249
249
---
250
250
251
- <a href =" .. /src/lazydocs/generation.py#L708" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
251
+ <a href =" https://github.com/ml-tooling/lazydocs/blob/main /src/lazydocs/generation.py#L708" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
252
252
253
253
### <kbd >method</kbd > ` overview2md `
254
254
@@ -263,4 +263,4 @@ Generates a documentation overview file based on the generated docs.
263
263
264
264
---
265
265
266
- _ This file was automatically generated via [ lazydocs] ( https://github.com/ml-tooling/lazydocs ) on 14 Nov 2020._
266
+ _ This file was automatically generated via [ lazydocs] ( https://github.com/ml-tooling/lazydocs ) on 16 Nov 2020._
0 commit comments