https://github.com/wasifsohail5/autodoc_devrolin
AutoDoc_Devrolin is an intelligent documentation automation platform designed to streamline technical documentation workflows for developers and organizations. The system automatically generates comprehensive documentation from codebases, keeping it synchronized with code changes, and providing an intuitive interface for customization.
https://github.com/wasifsohail5/autodoc_devrolin
automation docx2pdf fastapi python
Last synced: 9 months ago
JSON representation
AutoDoc_Devrolin is an intelligent documentation automation platform designed to streamline technical documentation workflows for developers and organizations. The system automatically generates comprehensive documentation from codebases, keeping it synchronized with code changes, and providing an intuitive interface for customization.
- Host: GitHub
- URL: https://github.com/wasifsohail5/autodoc_devrolin
- Owner: WasifSohail5
- Created: 2025-09-02T04:48:54.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-14T06:41:19.000Z (9 months ago)
- Last Synced: 2025-09-14T08:33:12.139Z (9 months ago)
- Topics: automation, docx2pdf, fastapi, python
- Language: Python
- Homepage:
- Size: 1.31 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📄 AutoDoc_Devrolin
[](https://opensource.org/licenses/MIT)
## 📋 Overview
AutoDoc_Devrolin is an intelligent documentation automation platform designed to streamline technical documentation workflows for developers and organizations. The system automatically generates comprehensive documentation from codebases, keeping it synchronized with code changes, and providing an intuitive interface for customization and collaboration.
## ✨ Key Features
- **Automated Documentation Generation**
- Code analysis and documentation extraction
- Support for multiple programming languages
- Intelligent comment parsing and structuring
- **Documentation Management**
- Version control integration
- Change tracking and history
- Collaborative editing with conflict resolution
- **Integration Capabilities**
- CI/CD pipeline integration
- IDE plugins for real-time documentation
- API for custom integrations
- **Advanced Formatting**
- Markdown and rich text support
- Automatic code highlighting
- Diagram generation from code structures
- **Publishing Tools**
- Multiple export formats (PDF, HTML, Wiki)
- Custom themes and branding
- Searchable online documentation portal
## 🛠️ Technologies Used
- **Frontend**: Vue.js, Vuex, Tailwind CSS
- **Backend**: Python, FastAPI
- **NLP Processing**: spaCy, NLTK
- **Code Analysis**: AST parsers, language-specific analyzers
- **Database**: PostgreSQL
- **Search**: Elasticsearch
- **DevOps**: Docker, Kubernetes, GitHub Actions
- **Storage**: MinIO/S3 compatible storage
## 🚀 Installation
```bash
# Clone the repository
git clone https://github.com/WasifSohail5/AutoDoc_Devrolin.git
# Navigate to the project directory
cd AutoDoc_Devrolin
# Set up Python virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install backend dependencies
pip install -r requirements.txt
# Install frontend dependencies
cd frontend
npm install
cd ..
# Set up environment variables
cp .env.example .env
# Edit .env with your configuration
# Start development servers
docker-compose up
```
## 💻 Usage
### Basic Usage
1. Configure your project by creating an `autodoc.yml` configuration file
2. Run the documentation generation command:
```bash
autodoc generate --source /path/to/codebase --output /path/to/docs
```
3. Access the generated documentation through the web interface at `http://localhost:8000`
### Advanced Features
```bash
# Generate documentation with specific templates
autodoc generate --template technical
# Watch mode for automatic updates
autodoc watch --source /path/to/codebase
# Integrate with CI/CD
autodoc ci --config autodoc-ci.yml
```
## 🔌 Supported Languages and Frameworks
- **Languages**: Python, JavaScript, TypeScript, Java, C#, Go, Ruby, PHP
- **Frameworks**: React, Angular, Vue, Django, Flask, Express, Spring Boot, .NET Core
- **Documentation Formats**: Markdown, reStructuredText, HTML, PDF, EPUB
## 📊 System Architecture
```
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ │ │ │ │ │
│ Code Analyzers ├───────┤ Processing Core ├───────┤ Template Engine│
│ │ │ │ │ │
└─────────────────┘ └─────────────────┘ └─────────────────┘
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│ │ │ │ │ │
│ Parser APIs │ │ Storage Layer │ │ Publishing Tools│
│ │ │ │ │ │
└─────────────────┘ └─────────────────┘ └─────────────────┘
```
## 🔧 Extensibility
AutoDoc_Devrolin is designed with extensibility in mind:
- **Custom Plugins**: Extend functionality with your own plugins
- **Template System**: Create custom documentation templates
- **API Integration**: Use our RESTful API to integrate with your tools
- **Custom Parsers**: Add support for additional languages or frameworks
## 🤝 Contributing
We welcome contributions to AutoDoc_Devrolin! Please follow these steps:
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
Please review our [Contributing Guidelines](CONTRIBUTING.md) for more details.
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 📸 Screenshots
## 📞 Contact
Wasif Sohail - [@WasifSohail5](https://github.com/WasifSohail5)
Project Link: [https://github.com/WasifSohail5/AutoDoc_Devrolin](https://github.com/WasifSohail5/AutoDoc_Devrolin)
---
Built with ❤️ by Wasif Sohail and contributors