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.4b0.tar.gz
(2.8 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.4b0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.4b0.tar.gz
- Upload date:
- Size: 2.8 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 | 22fec5e69626495409dc03a306051ca67d089e137e62d008cf6c9adf5a708ef6 |
|
| MD5 | 9dad02afb64fa28c8761050a05e50150 |
|
| BLAKE2b-256 | c15c106de265c1f187c77ad5c0e691c1ba1a7861d505709ed3ee6fa8ec3845a0 |
File details
Details for the file pydocgen-0.0.4b0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.4b0-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 | dd5912a3589b5b909ce8fbfa7171cba963fb9c84ff3d3ea84cbb9f2c0616058b |
|
| MD5 | f2ab3856cee05dd107547a53fbac9623 |
|
| BLAKE2b-256 | d913e465f4197e68263fb73764b816a23df289f957fe05faf5c8f9f4a1aec92c |
