Generate documentation
Project description
Gendoc
Generates documentation based on function docstrings.
Installation
The package is available on pypi. You can install it with pip
pip install gendoc-cli
How to use it 🤔 ?
gendoc <filename>
Optional parameters
--out=<output-dir> The output directory
--recursive To collect all python files from the directory
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gendoc-cli-0.0.1.tar.gz
(4.7 kB
view details)
Built Distribution
File details
Details for the file gendoc-cli-0.0.1.tar.gz.
File metadata
- Download URL: gendoc-cli-0.0.1.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.0 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0023dc573952d5090bf0c943b869a043806a73bb820f8bbcea33f51dc271a6b7 |
|
| MD5 | 784b05c4e1bc16c74fe5eee51fa30df8 |
|
| BLAKE2b-256 | 659454a64700b886c2117685ebe79e484a431a2df924ec267bbe063d3f8088d6 |
File details
Details for the file gendoc_cli-0.0.1-py3-none-any.whl.
File metadata
- Download URL: gendoc_cli-0.0.1-py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.0 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 36a88cf197a8c48ac11f6ebb0236c1821f8601a9749d18a05d9643af287f86bb |
|
| MD5 | e9ccf9945d210b3038371dbb376428de |
|
| BLAKE2b-256 | 5aada2bdfdb26fdfce72ee743f8d531bdde0ce3ee6ca5e93ee37a78484f87673 |
