Skip to main content

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


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 hashes)

Uploaded Source

Built Distribution

pydocgen-0.0.4rc0-py3-none-any.whl (4.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page