Skip to content

Commit 3dde437

Browse files
authored
Merge pull request #30 from SamVanhoutte/bugfix/img-tag
Fix img tag html. Closes #29
2 parents b0944bc + 03ae1b6 commit 3dde437

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/lazydocs.generation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!-- markdownlint-disable -->
22

3-
<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+
<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>
44

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

88

99
---
1010

11-
<a href="https://github.com/ml-tooling/lazydocs/blob/main/src/lazydocs/generation.py#L197"><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#L197"><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

@@ -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#L889"><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#L889"><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#L454"><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#L454"><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#L457"><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#L457"><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#L609"><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#L609"><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#L524"><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#L524"><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#L815"><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#L815"><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#L720"><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#L720"><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#L835"><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#L835"><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

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.4.8"
3+
__version__ = "0.5.0-dev.bugfix"
44
# __author__
55
# __email__

src/lazydocs/generation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
# String templates
3030

3131
_SOURCE_BADGE_TEMPLATE = """
32-
<a href="{path}"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
32+
<a href="{path}"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square" /></a>
3333
"""
3434

3535
_SEPARATOR = """

0 commit comments

Comments
 (0)