Home

Welcome to the Academic Document Generator documentation!
Transform annotated PDFs into professional LaTeX documents using AI. Generate thesis colloquium protocols, project grading letters, peer review comments, and translate LaTeX exams automatically.
π Four Main Use Cases¶
-
π Colloquium Protocols
- Notes β clear questions
- Auto-metadata extraction
- Thesis summary
- Form pre-filling
- Email generation
-
π Project Work Grading
- Metadata extraction
- Salutation determination (Mr/Ms)
- Grading letter template
- Feedback summary
- Student email
-
βοΈ Peer Review Comments
- Notes β constructive feedback
- Auto line number detection
- Markdown export
- Always in English
- Scientific tone
-
π€ LaTeX Exam Translator
- German β English
- Exam class optimized
- Preserves math formulas
- Protected comments
- Structure-aware
π― Quick Links¶
-
Quick Start
Get started in minutes with our installation guide
-
Configuration
Configure your LLM APIs and templates
-
Examples
View examples of generated documents
-
API Reference
Complete API documentation for developers
β¨ Key Features¶
- π Unified CLI - Single
academic-doc-generatorcommand for all tasks - π PDF Annotation Extraction - Extract text and annotation positions with Docling + PyPDF
- π€ Multiple LLM Support - Works with OpenAI, Groq, Google Gemini, or Ollama
- π― Context-Aware Rewriting - Maps annotations to exact highlighted text and paragraphs
- βοΈ Intelligent Comment Refinement - Rewrites terse notes into full questions
- π LaTeX Generation - Creates professional letters with TH KΓΆln formatting
- βοΈ Automatic Signature Detection - Automatically includes signature from
data/signature.png - π PDF Form Pre-filling - Auto-fills official grading forms (auto-mapped to course of study)
- π§ Email & Outlook Integration - Creates registration emails and Outlook drafts
- π Unicode Support - Handles German special characters correctly
π οΈ Requirements¶
- Python: 3.9 or higher
- LaTeX: LuaLaTeX recommended (for Unicode support)
- LLM API: At least one of OpenAI, Groq, Gemini, or Ollama
π€ Contributing¶
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
π License¶
This project is released under the MIT License.
Note: This tool aids in document template creation β it does not mark or make evaluative decisions automatically. All academic assessments remain the responsibility of the examiner.