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.2b0.tar.gz
(2.7 kB
view details)
Built Distribution
File details
Details for the file pydocgen-0.0.2b0.tar.gz.
File metadata
- Download URL: pydocgen-0.0.2b0.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 | 532d7c6534dc52489229a1d9e1de83e14dc3d06a104b2be0e2e18152c1273b00 |
|
| MD5 | 6815e671498b4b1c068da048b000453a |
|
| BLAKE2b-256 | 9dabb52244474076253a9f7c62cda6e0e8255e4529c3194af04a033791bb152f |
File details
Details for the file pydocgen-0.0.2b0-py3-none-any.whl.
File metadata
- Download URL: pydocgen-0.0.2b0-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 | 6227325ac72983da849fe5e4151d06298443018300f00c234495bac084067ea9 |
|
| MD5 | 089cebb00ca2d336a7a81924404b18b0 |
|
| BLAKE2b-256 | 32dc4bd2c5e8010dc41b97379acdf33a404322abf69e98cdca5b6fc878f587bb |
