Metadata-Version: 2.1
Name: GenDoc
Version: 0.0.32
Summary: Generate a Markdown Documentation file from a Python Repository with DocStrings.
Home-page: https://github.com/http-samc/GenDoc
Author: Samarth Chitgopekar
Author-email: sam@chitgopekar.tech
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown

# GenDoc
 Generate a Markdown Documentation file from a Python Repository with docstrings.

# Installation
1. From PIP (recommended)
```Python
pip install gendoc
--
pip3 install gendoc
```
2. From source
   1. Clone this repo
   2. Install [requirements.txt](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) <br>
``--v`` -> Version Number (included in Docs) (Project Name required to use) <br>
``--f`` -> PATH to files you want to include in the generation<br>
``--d`` -> PATH to the parent directory of the codebase (used only without --f) <br>
``--o`` -> PATH to the output Markdown file <br>
``--e`` -> Message for function without a DocString (enter 0 to exclude functions without a DocString entirely) <br>

