Skip to content
/ pydocgen Public

An automatic docstring and documentation generator with type inference

License

Notifications You must be signed in to change notification settings

m0bi5/pydocgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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)

About

An automatic docstring and documentation generator with type inference

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages