GenDoc 0.0.96

Generate a Markdown Documentation file from a Python Repository with DocStrings.

GenDoc

• Generate a Markdown Documentation file from a Python Repository with DocStrings.
• Pure 🐍 implementation with no external packages
• Tiny Tech Stack: os, ast, argparse, typing

Installation

pip install gendoc
--
pip3 install gendoc

Use

GenDoc is a CLI based application. After installation, you can call the utility in any terminal application as follows: PS C:\users\...\foo> gendoc
Aditionaly, you can use the following flags in your terminal:

---

--help | -h Show a help dialog
--name | --n Project Name (included in Docs) (not included if not provided)
--version | --v Version Number (included in Docs) (Project Name required to use) (not included if not provided)
--files | --f PATH to specific files you want to include in the Doc generation (only pulls from these files) (defaults to all .py files in the current directory)
--dir | --d PATH to the parent directory of the codebase (used only without --f) (defaults to all .py files in the current directory)
--output | --o PATH to the output Markdown file (defaults to DOCS.md in current directory)
--emptyfunc | --e Message for function without a DocString (enter 0 to exclude functions without a DocString entirely) (defaults to "No documentation provided.")

Future Development

GenDoc was developed to be a simple, plug-and-play package. However, due to the level of styling customization required for many projects' documentation, an additional html-based API is being developed so developers can use their own external stylesheets.

PRs are welcome, and please contact Samarth Chitgopekar for any questions, comments, or concerns.