Automatically generate docstrings and documentation files for your code!
Project description
PyDocGen
Automatically generate docstrings and documentation for your Python modules!
Installation
pip install pydocgen
Usage
Pydocgen currently will accept a Python module file, it will support packages in the near future
pydocgen --help #View all options
pydocgen -i file_name
Features
- Easy to use, quick way to document your code
- Input module file will automatically be decorated with docstrings (under development)
- Only need to fill in variable and function description
- Automatic type inference!
- Documentation files will be generated automatically (current supports HTML)
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
pydocgen-0.0.4a0.tar.gz
(2.7 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.4a0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.4a0.tar.gz
- Upload date:
- Size: 2.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.52.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3f6549a5701dd507d899c24ad8ddce1675c2e63c68ad38ac60862bdd6afc5989 |
|
| MD5 | cc06dbfacdfc1b444726b1e67eb5a9d3 |
|
| BLAKE2b-256 | c6f774d18bcf4700e4a3575f3f9613aef14801421cf94825c7fc110eb7757067 |
File details
Details for the file pydocgen-0.0.4a0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.4a0-py3-none-any.whl
- Upload date:
- Size: 4.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.52.0 CPython/3.7.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9667a2dd4a3085da3cdb3bf8fa3e8e466516d74c4cb7c8ad839ff26f41db2783 |
|
| MD5 | 3438bfb7dbe6d2e342287df9b4d5becb |
|
| BLAKE2b-256 | a57c356b7d535c19caa7627bf40a3bcf1917e98847ff75e68181bf5405b5b1c8 |
