Skip to content

Commit c1c10cf

Browse files
committed
Rename console output to print to console
1 parent e2bd9bf commit c1c10cf

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ This project is maintained by [Benjamin Räthlein](https://twitter.com/raethlein
7777
<a href="#api-overview">API Overview</a> •
7878
<a href="#mkdocs-integration">MKDocs Integration</a> •
7979
<a href="#docstyle-validation">Docstyle Validation</a> •
80-
<a href="#console-output">Console Output</a>
80+
<a href="#print-to-console">Print to Console</a>
8181
</p>
8282

8383
### Source Code Linking
8484

8585
<img style="width: 100%" src="./docs/images/source-linking.png"/>
8686

87-
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`:
87+
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

8989
```bash
9090
lazydocs --src-base-url="https://github.com/example/my-project/blob/main/" my_package
@@ -102,10 +102,12 @@ An API overview might be very useful in case your project has a large number mod
102102
lazydocs --overview-file="README.md" my_package
103103
```
104104

105-
The API overview will be written as markdown to the specified file with seperated lists for all modules, classes, and functions of your project:
105+
The API overview will be written as markdown to the specified file with separated lists for all modules, classes, and functions of your project:
106106

107107
### MKDocs Integration
108108

109+
110+
109111
### Docstyle Validation
110112

111113
Lazydocs can only parse valid Google-style docstring. To prevent the generation of invalid markdown documentation, you can use the `validate` flag:
@@ -116,7 +118,7 @@ layzdocs --validate my_package
116118

117119
This will run [pydocstyle](https://github.com/PyCQA/pydocstyle) on your docstring and cancel the generation if an issue is found.
118120

119-
### Console Output
121+
### Print to Console
120122

121123
To get the markdown documentation as console output instead of the file generation, specify `stdout` as the `output-path`:
122124

0 commit comments

Comments
 (0)