Skip to content

Commit 148601e

Browse files
committed
Update API docs
1 parent 33385ba commit 148601e

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/lazydocs.generation.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Main module for markdown generation.
88

99
---
1010

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

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

1515
```python
1616
to_md_file(
17-
string: str,
17+
markdown_str: str,
1818
filename: str,
1919
out_path: str = '',
2020
watermark: bool = True,
@@ -28,7 +28,7 @@ Creates an API docs file from a provided text.
2828

2929
**Args:**
3030

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.
3232
- <b>`filename`</b> (str): Filename without the .md
3333
- <b>`watermark`</b> (bool): If `True`, add a watermark with a timestamp to bottom of the markdown files.
3434
- <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.
3737

3838
---
3939

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

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

@@ -74,12 +74,12 @@ Generates markdown documentation for provided paths based on Google-style docstr
7474

7575
---
7676

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

7979
## <kbd>class</kbd> `MarkdownGenerator`
8080
Markdown generator class.
8181

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

8484
### <kbd>method</kbd> `__init__`
8585

@@ -106,7 +106,7 @@ Initializes the markdown API generator.
106106

107107
---
108108

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

111111
### <kbd>method</kbd> `class2md`
112112

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

132132
---
133133

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

136136
### <kbd>method</kbd> `func2md`
137137

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

158158
---
159159

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

162162
### <kbd>method</kbd> `import2md`
163163

@@ -182,7 +182,7 @@ Generates markdown documentation for a selected object/import.
182182

183183
---
184184

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

187187
### <kbd>method</kbd> `module2md`
188188

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

208208
---
209209

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

212212
### <kbd>method</kbd> `overview2md`
213213

0 commit comments

Comments
 (0)