Skip to content

Commit 1678339

Browse files
Finalize release for version 0.2.3 (#4)
Co-authored-by: LukasMasuch <LukasMasuch@users.noreply.github.com>
1 parent 9ab1f2b commit 1678339

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

docs/.pages

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: API Reference
2+
nav:
3+
- Overview: README.md
4+
- ...

docs/lazydocs.generation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Main module for markdown generation.
77

88
---
99

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

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

@@ -34,7 +34,7 @@ Creates an API docs file from a provided text.
3434

3535
---
3636

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

3939
## <kbd>function</kbd> `generate_docs`
4040

@@ -71,13 +71,13 @@ Generates markdown documentation for provided paths based on Google-style docstr
7171

7272
---
7373

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

7676
## <kbd>class</kbd> `MarkdownGenerator`
7777
Markdown generator class.
7878

7979

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

8282
### <kbd>method</kbd> `__init__`
8383

@@ -103,7 +103,7 @@ Initializes the markdown API generator.
103103

104104
---
105105

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

108108
### <kbd>method</kbd> `class2md`
109109

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

129129
---
130130

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

133133
### <kbd>method</kbd> `doc2md`
134134

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

153153
---
154154

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

157157
### <kbd>method</kbd> `func2md`
158158

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

179179
---
180180

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

183183
### <kbd>method</kbd> `import2md`
184184

@@ -203,7 +203,7 @@ Generates markdown documentation for a selected object/import.
203203

204204
---
205205

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

208208
### <kbd>method</kbd> `module2md`
209209

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

229229
---
230230

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

233233
### <kbd>method</kbd> `overview2md`
234234

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.2.2"
3+
__version__ = "0.2.3"
44
# __author__
55
# __email__

0 commit comments

Comments
 (0)