Overview
docforge turns GSDFC-compliant Python docstrings into maintainable reference
documentation. It never edits source docstrings; it reads them, renders them,
and assembles a single MkDocs site from all available material.
What it generates
| Kind | Source | Output |
|---|---|---|
lib |
GSDFC docstrings | docs/lib/** rendered markdown |
api |
OpenAPI JSON spec | docs/api/** rendered markdown |
wiki |
Hand-written markdown | docs/wiki/** (unchanged) |
mcp |
Griffe + renderers | docs/mcp/** structured files |
Combined build
One mkdocs.yml and one MkDocs build serve all kinds:
- Wiki navigation is derived from the
docs/wiki/file structure. - Generated library/API navigation is appended after it.
- The wiki
index.mdbecomes the siteHome.
Hand-written wiki content is never overwritten or regenerated — only its navigation is derived automatically.