Skip to content

Commit 4ce9222

Browse files
committed
Update api overview image
1 parent 4c56127 commit 4ce9222

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,15 @@ lazydocs --src-base-url="https://github.com/example/my-project/blob/main/" my_pa
9393

9494
### API Overview
9595

96+
<img style="width: 100%" src="./docs/images/api-overview.png"/>
97+
9698
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:
9799

98100
```bash
99101
lazydocs --overview-file="README.md" my_package
100102
```
101103

102-
The API Overview will be written as markdown to the specified file with sperated lists for all modules, classes, and functions of your project:
103-
104-
<img style="width: 100%" src="./docs/images/api-overview.png"/>
104+
The API overview will be written as markdown to the specified file with seperated lists for all modules, classes, and functions of your project:
105105

106106
### MKDocs Integration
107107

docs/images/api-overview.png

-27.3 KB
Loading

0 commit comments

Comments
 (0)