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)
Project details
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.2a0.tar.gz
(2.7 kB
view hashes)
Built Distribution
Close
Hashes for pydocgen-0.0.2a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab2c0471b5a0c02c73a6593ef904b5fe978670b2a73a6c1959e32c087e3e2972 |
|
MD5 | 96eb3cf3f80b79fedee036d1e2bb6963 |
|
BLAKE2b-256 | 4bd2d19291c6c058de63c798bae9b6bbdecc758ef8d1fe443eea583b33daf834 |