Skip to content

Commit c824607

Browse files
committed
Merge branch 'main' of https://github.com/ml-tooling/lazydocs into main
2 parents f11afbc + 81a5cdd commit c824607

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/lazydocs.generation.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11

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>
33

44
# <kbd>module</kbd> `lazydocs.generation`
55
Main module for markdown generation.
66

77

88
---
99

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>
1111

1212
## <kbd>function</kbd> `to_md_file`
1313

@@ -37,7 +37,7 @@ Creates an API docs file from a provided text.
3737

3838
---
3939

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>
4141

4242
## <kbd>function</kbd> `generate_docs`
4343

@@ -82,14 +82,14 @@ Generates markdown documentation for provided paths based on Google-style docstr
8282

8383
---
8484

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>
8686

8787
## <kbd>class</kbd> `MarkdownGenerator`
8888
Markdown generator class.
8989

9090

9191

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>
9393

9494
### <kbd>method</kbd> `__init__`
9595

@@ -118,7 +118,7 @@ Initializes the markdown API generator.
118118

119119
---
120120

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>
122122

123123
### <kbd>method</kbd> `class2md`
124124

@@ -144,7 +144,7 @@ Takes a class and creates markdown text to document its methods and variables.
144144

145145
---
146146

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>
148148

149149
### <kbd>method</kbd> `doc2md`
150150

@@ -168,7 +168,7 @@ Parse docstring (with getdoc) according to Google-style formatting and convert t
168168

169169
---
170170

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>
172172

173173
### <kbd>method</kbd> `func2md`
174174

@@ -196,7 +196,7 @@ Takes a function (or method) and generates markdown docs.
196196

197197
---
198198

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>
200200

201201
### <kbd>method</kbd> `import2md`
202202

@@ -222,7 +222,7 @@ Generates markdown documentation for a selected object/import.
222222

223223
---
224224

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>
226226

227227
### <kbd>method</kbd> `module2md`
228228

@@ -248,7 +248,7 @@ Takes an imported module object and create a Markdown string containing function
248248

249249
---
250250

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>
252252

253253
### <kbd>method</kbd> `overview2md`
254254

@@ -263,4 +263,4 @@ Generates a documentation overview file based on the generated docs.
263263

264264
---
265265

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._

src/lazydocs/_about.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Information about this library. This file will automatically changed."""
22

3-
__version__ = "0.1.3"
3+
__version__ = "0.2.0"
44
# __author__
55
# __email__

0 commit comments

Comments
 (0)