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
- From PIP (recommended)
pip install gendoc
--
pip3 install gendoc
- From source
- Clone this repo
- Install requirements.txt
Use
GenDoc is a CLI based application using ArgParse. After installation, you can use any of the following flags in your terminal:
--n
-> Project Name (included in Docs)
--v
-> Version Number (included in Docs) (Project Name required to use)
--f
-> PATH to files you want to include in the generation
--d
-> PATH to the parent directory of the codebase (used only without --f)
--o
-> PATH to the output Markdown file
--e
-> Message for function without a DocString (enter 0 to exclude functions without a DocString entirely)
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.