https://github.com/lainq/gendoc
gendoc is a tool which generates documentation based on your docstrings
https://github.com/lainq/gendoc
cli docstrings documentation documentation-generator gendoc python python3
Last synced: 10 months ago
JSON representation
gendoc is a tool which generates documentation based on your docstrings
- Host: GitHub
- URL: https://github.com/lainq/gendoc
- Owner: lainq
- License: mit
- Created: 2021-11-29T10:10:50.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-02T11:52:38.000Z (about 4 years ago)
- Last Synced: 2024-10-09T09:54:53.121Z (about 1 year ago)
- Topics: cli, docstrings, documentation, documentation-generator, gendoc, python, python3
- Language: Python
- Homepage: https://github.com/pranavbaburaj/gendoc
- Size: 22.5 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Gendoc
Generates documentation based on function docstrings.
### Installation
The package is available on pypi. You can install it with pip
```py
pip install gendoc-cli
```
### How to use it 🤔 ?
```
gendoc
```
##### Optional parameters
`--out=` The output directory
`--recursive` To collect all python files from the directory