Skip to content

Commit 32b2918

Browse files
lukasmasuchactions-user
authored andcommitted
Apply automatic release changes for v0.4.6
1 parent 706d545 commit 32b2918

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

Pipfile.lock

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/lazydocs.generation.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -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#L859"><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#L875"><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

@@ -48,7 +48,7 @@ generate_docs(
4848
src_root_path: Optional[str] = None,
4949
src_base_url: Optional[str] = None,
5050
remove_package_prefix: bool = False,
51-
ignored_modules: List[str] = [],
51+
ignored_modules: Optional[List[str]] = None,
5252
overview_file: Optional[str] = None,
5353
watermark: bool = True,
5454
validate: bool = False
@@ -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#L424"><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#L440"><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#L427"><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#L443"><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#L579"><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#L595"><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#L494"><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#L510"><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#L785"><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#L801"><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#L690"><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#L706"><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#L805"><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#L821"><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

src/lazydocs/_about.py

+1-1
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.4.4"
3+
__version__ = "0.4.6"
44
# __author__
55
# __email__

0 commit comments

Comments
 (0)