Skip to content

Commit 6f2e1c9

Browse files
committed
Use github urls for images
1 parent 48bcb0e commit 6f2e1c9

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein
8282

8383
### Source Code Linking
8484

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

8787
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`:
8888

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

9595
### API Overview
9696

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

9999
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:
100100

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

107107
### MkDocs Integration
108108

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

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

0 commit comments

Comments
 (0)