Skip to content

Commit 409f2a4

Browse files
committed
Fix image links in readme
1 parent 6f2e1c9 commit 409f2a4

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
</p>
99

1010
<p align="center">
11+
<a href="https://pypi.org/project/lazydocs/" title="PyPi Version"><img src="https://img.shields.io/pypi/v/lazydocs?color=green&style=flat"></a>
1112
<a href="https://github.com/ml-tooling/lazydocs/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/ml-tooling/lazydocs?style=flat"></a>
1213
<a href="https://github.com/ml-tooling/lazydocs/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/ml-tooling/lazydocs?style=flat"></a>
1314
<a href="https://github.com/ml-tooling/lazydocs/blob/main/LICENSE" title="Project License"><img src="https://img.shields.io/badge/License-MIT-green.svg"></a>
@@ -82,7 +83,7 @@ This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein
8283

8384
### Source Code Linking
8485

85-
<img style="width: 100%" src="https://github.com/ml-tooling/lazydocs/blob/main/docs/images/source-linking.png"/>
86+
<img style="width: 100%" src="https://raw.githubusercontent.com/ml-tooling/lazydocs/main/docs/images/source-linking.png"/>
8687

8788
Lazydocs is capable to insert a badge on the right side of every module, class, method or function with a link the correct source-code file and line number. The default configuration will create relative paths to navigate within the Github Repo. This is useful if the documentation is hosted within the same repository as the source-code. If, the documentation is hosted outside of the Github repository, it is recommended to set the `src-base-url`:
8889

@@ -94,7 +95,7 @@ The `src-base-url` is used as a prefix for all source-code linkings in the docum
9495

9596
### API Overview
9697

97-
<img style="width: 100%" src="https://github.com/ml-tooling/lazydocs/blob/main/docs/images/docs/images/api-overview.png"/>
98+
<img style="width: 100%" src="https://raw.githubusercontent.com/ml-tooling/lazydocs/main/docs/images/api-overview.png"/>
9899

99100
An API overview might be very useful in case your project has a large number modules, classes and functions. You can specify an `overview-file` with the lazydocs command to activate the generation of an API overview:
100101

@@ -106,7 +107,7 @@ The API overview will be written as markdown to the specified file with separate
106107

107108
### MkDocs Integration
108109

109-
<img style="width: 100%" src="https://github.com/ml-tooling/lazydocs/blob/main/docs/images/mkdocs-integration.png"/>
110+
<img style="width: 100%" src="https://github.com/ml-tooling/lazydocs/blob/main/docs/images/mkdocs-integration.png?raw=true"/>
110111

111112
The markdown documentation generated by lazydocs can be easily integrated into your [mkdocs](https://www.mkdocs.org/) documentation site:
112113

0 commit comments

Comments
 (0)