🔨 docforge — Docstring-Driven Documentation Forge
docforge is an internal documentation tool that generates reference
documentation from Google-Styled Doc-Forge Convention (GSDFC) docstrings and
assembles it into a single MkDocs site, alongside hand-written wiki pages and
OpenAPI-based API docs.
🚀 Key Features
- 🧪 GSDFC docstring extraction via Griffe
- 🧭 Auto-derived navigation for hand-written wiki pages
- 🗂 Combined MkDocs build: wiki first, then generated library/API reference
- 🔌 Material MkDocs theming out of the box
- 📦 MCP structured documentation resources
📁 Documentation Structure
| Section | Description |
|---|---|
| Overview | What docforge is and how it fits the pipeline |
| Architecture | Loaders, models, nav, renderers, CLI |
| Conventions | GSDFC, .pyi stubs, and template conventions |
| Iterative Workflow | How a docs build runs end to end |
| Development | Environment setup and quality gates |
🔗 Related Resources
- Source Code:
C:\Users\vishe\WorkSpace\code\aetos\doc-forge - Wiki Kind: hand-written content lives in
docs/wiki/
© Aetoskia Internal