Skip to content

📝 Lightweight documentation generator designed for simplicity and efficiency

License

Notifications You must be signed in to change notification settings

miguelcsx/docflow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docflow

📝 Lightweight documentation generator designed for simplicity and efficiency

DocFlow

Features

  • Generate documentation from user code in two selectable formats: code docstring and Markdown.
  • Simple and intuitive interface for ease of use.
  • Integration with AI model (Anthropic, Google, OpenAI) for enhanced processing capabilities.
  • Customizable output format.
  • Lightweight and efficient, minimizing overhead.
  • Supports multiple programming languages.

Getting Started

1. Clone the repository

git clone https://github.com/miguelcsx/docflow.git

2. Install the required dependencies

pip install -r requirements.txt

3. Run the application

reflex init
reflex run

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have any suggestions or improvements.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

📝 Lightweight documentation generator designed for simplicity and efficiency

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages