🔨 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 per-kind MkDocs sites, 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
- 🗂 Independent MkDocs builds per kind (lib, api, wiki) into
site/{kind} - 🔌 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, servers |
| Conventions | GSDFC, .pyi stubs, and template conventions |
| Iterative Workflow | How a docs build runs end to end |
| Development | Environment setup and quality gates |
| Docstring Guide | How to write GSDFC-conformant docstrings |
| MCP Guide | Building, serving, and consuming the MCP bundle |
🔗 Related Resources
- Source Code: the
doc-forgerepository - Wiki Kind: hand-written content lives in
docs/wiki/ - MCP Bundle: generated by
doc-forge build --mcp --module docforgeintodocs/mcp/
© Aetoskia Internal