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.1rc0.tar.gz
(2.6 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.1rc0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.1rc0.tar.gz
- Upload date:
- Size: 2.6 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 | c1b92441dd38347d1280cd0d102b5d5b16fb36f51171a32864031f37d824e7be |
|
| MD5 | 14b04967b7dadee813190b3c0b7f4ffb |
|
| BLAKE2b-256 | 8aad06eccfca831002f8662ae497f968a48de7d6a9dabd7075065f2c13b49354 |
File details
Details for the file pydocgen-0.0.1rc0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.1rc0-py3-none-any.whl
- Upload date:
- Size: 4.7 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 | 4b3a9df7c98710d5cfa98006e18c428bcbb6360f810155d80f7cbfdaeaf55fc1 |
|
| MD5 | 648707d22dc63973c8423d7e5c272f9f |
|
| BLAKE2b-256 | 9e2945507ad4b59a8ca57bb829e4ff03b2c871d6027e5f20951cf1a8ffd32a4f |
