Skip to content

Commit 12cf39a

Browse files
committed
Update readme to reflect the generation of the .pages file
1 parent 67bfa57 commit 12cf39a

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,15 @@ The markdown documentation generated by lazydocs can be easily integrated into y
115115

116116
```bash
117117
lazydocs \
118+
--output_path="./docs/api-docs" \
118119
--overview-file="README.md" \
119120
--src-base-url="https://github.com/example/my-project/blob/main/" \
120121
my_package
121122
```
122123

123124
2. Install and apply the [awesome-pages mkdocs plugin](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin). This enables mkdocs to automatically discover and include all markdown files. The alternative would be to manually include all generated markdown files in the navigation section of the `mkdocs.yaml`. In order to use the awesome-pages plugin you need to 1) install the plugin via pip 2) Include it in the plugin section `mkdocs.yaml` and remove the navigation section (needs to be handled with `.pages` files).
124125

125-
3. Create a `.pages` file within the api-docs subfolder (e.g. `api-docs`) with the following content:
126+
3. If you used the `overview-file` option, a `.pages` file will be automatically created. You can also manually create the `.pages` file within the api-docs subfolder (e.g. `api-docs`) with the following content:
126127

127128
```yaml
128129
title: API Reference

0 commit comments

Comments
 (0)