/gendoc

gendoc is a tool which generates documentation based on your docstrings

Primary LanguagePythonMIT LicenseMIT

Gendoc

Generates documentation based on function docstrings.

Installation

The package is available on pypi. You can install it with pip

pip install gendoc-cli

How to use it 🤔 ?

gendoc <filename>
Optional parameters

--out=<output-dir> The output directory

--recursive To collect all python files from the directory