# OpenAI Doc Sum

**Repository Path**: yhyu13/open-ai-doc-sum

## Basic Information

- **Project Name**: OpenAI Doc Sum
- **Description**: Summerize python source code into markdown using openai api
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-23
- **Last Updated**: 2024-02-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

With the help of Chatgpt, you can write document for python source file in a brand new way

By generating a .md file along side your python file, you can easily share your code with others.

```
# You can edit the config.json file to customize the output.
cp config.json.example config.json

# Generate the.md file
cd Util/openai-doc-sum
python source_md5.py --input_dir ../../Source --output_dir ./Output --clean
python gen_file_md.py 
python gen_sum_md.py --input ./Output/
code file_links.md
```