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.4rc0.tar.gz
(2.8 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.4rc0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.4rc0.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 | be51f99c128139f85b74b8401e2e84fde6b8caec16758dc10ee7da7e3f6b4c5f |
|
| MD5 | b97591015876ed70b07edcd1ce545ba1 |
|
| BLAKE2b-256 | 701d07466b33929839a6b67399627f6d6c3e0fd5b7455c3f9ba673df68359c08 |
File details
Details for the file pydocgen-0.0.4rc0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.4rc0-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 | 8388703deafecf871f69bc2f118a88f3fa203ff175ae50ec56345256042f29ef |
|
| MD5 | 5cec0ba65f825a6266bbfb4d3552e2bd |
|
| BLAKE2b-256 | 503de908d7d4371c36ad079c1111f1b6b5909d1c584392a45b99d842761551c2 |
