Generate a Markdown Documentation file from a Python Repository with DocStrings.
Project description
GenDoc
Generate a Markdown Documentation file from a Python Repository with DocStrings.
Installation
pip install gendoc
--
pip3 install gendoc
Use
GenDoc is a CLI based application using ArgParse. After installation, you can call the utility in any terminal application as follows:
C:\...\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 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.")
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.