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.2rc0.tar.gz
(2.7 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.2rc0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.2rc0.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 | 628d14af84b4890567a2821279376fac1d93ecf0a28d70aaed61bce4e77198be |
|
| MD5 | c710d1177a0435deca7ac9bf75dfdf7d |
|
| BLAKE2b-256 | d1f831638cc0b1a3cdfe30835f99fa025a315cbaf7dcab1377df4f00dc8fa77f |
File details
Details for the file pydocgen-0.0.2rc0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.2rc0-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 | a0123eef03f3886af5ec9521ab091a947f93c856cdcd01ee1f323e63d666f6d9 |
|
| MD5 | 864c821b80699b2742b767ccd7a82b64 |
|
| BLAKE2b-256 | cbbd2465ede62a3fd6192d9fc55aae8d744c470cad097b7667919a8f1f40e71e |
