docugen/README.md

15 lines
336 B
Markdown
Raw Permalink Normal View History

2022-12-05 20:30:23 -08:00
# docugen
2022-12-12 14:35:49 -08:00
Generating documentation using OpenAI LLMs
![](example/out.png)
2022-12-05 20:30:23 -08:00
[Example input](example/example_code.py)
[Example output](example/example_code-doc.md)
2022-12-12 14:35:49 -08:00
## Spec
- Connecting to ChatGPT with [revChatGPT](https://github.com/acheong08/ChatGPT)
- Currently only supports Python source code & extracts top-level functions only