Project Documentation

Auto-generated API documentation

26 modules
51 functions
28 classes

Modules

πŸ“¦ __init__
Autoredocs β€” Real-time, self-maintaining code documentation tool.
0 functions Β· 0 classes
πŸ“¦ ai
AI-powered docstring generation using Groq API (Llama models).
0 functions Β· 1 classes
πŸ“¦ cli
Autoredocs CLI β€” command-line interface for generating code documentation.
11 functions Β· 0 classes
πŸ“¦ config
Configuration management for autoredocs.
0 functions Β· 2 classes
πŸ“¦ deploy
Static site deploy module β€” push generated docs to hosting providers.
1 functions Β· 4 classes
πŸ“¦ generator
Documentation generator β€” renders parsed code into Markdown and HTML.
0 functions Β· 2 classes
πŸ“¦ models
Data models for extracted documentation.
0 functions Β· 5 classes
πŸ“¦ parser
Backward-compatible re-export.
0 functions Β· 0 classes
πŸ“¦ parsers
Parser registry β€” maps file extensions to parser classes.
1 functions Β· 0 classes
πŸ“¦ parsers.base
Abstract base parser for all language parsers.
0 functions Β· 2 classes
πŸ“¦ parsers.cpp
C/C++ regex-based parser.
5 functions Β· 1 classes
πŸ“¦ parsers.csharp
C# regex-based parser.
4 functions Β· 1 classes
πŸ“¦ parsers.go
Go regex-based parser.
3 functions Β· 1 classes
πŸ“¦ parsers.java
Java regex-based parser.
2 functions Β· 1 classes
πŸ“¦ parsers.kotlin
Kotlin regex-based parser.
4 functions Β· 1 classes
Python AST-based parser β€” refactored to extend BaseParser.
0 functions Β· 1 classes
πŸ“¦ parsers.ruby
Ruby regex-based parser.
4 functions Β· 1 classes
πŸ“¦ parsers.rust
Rust regex-based parser.
4 functions Β· 1 classes
TypeScript / JavaScript regex-based parser.
3 functions Β· 1 classes
πŸ“¦ reporter
Build change reporter β€” structured summaries of documentation changes.
0 functions Β· 2 classes
πŸ“¦ scaffold
Scaffold templates for ``autoredocs init``.
3 functions Β· 0 classes
πŸ“¦ server
FastAPI server for autoredocs β€” live documentation build & serve.
2 functions Β· 0 classes
AWS Lambda handler for autoredocs.
2 functions Β· 0 classes
Vercel serverless function handler for autoredocs.
1 functions Β· 0 classes
πŸ“¦ state
State tracking for incremental documentation builds.
0 functions Β· 1 classes
πŸ“¦ watcher
File watcher for real-time documentation regeneration.
1 functions Β· 0 classes