aetos/doc-forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
582b6809a07090d26a019f570a3e3fd5ecc99063
doc-forge/docs/wiki/01_overview.md
Vishesh 'ironeagle' Bangotra 582b6809a0 docs: bring docforge docstrings and wiki to GSDFC standard 
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README
- rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs
- add pydoclint (google style) gate to dev extras and pyproject config
- fix mcp nav resources doc:// -> docs://
- refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group
- update wiki pages and add GSDFC + MCP guides under 05_development
2026-09-12 13:12:51 +05:30

1.3 KiB
Raw Blame History

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 GSDFC docstrings + renderers docs/mcp/** structured JSON

Combined build

One mkdocs.yml and one MkDocs build serve all kinds:

  1. Wiki navigation is derived from the docs/wiki/ file structure.
  2. Generated library/API navigation is appended after it.
  3. The wiki index.md becomes the site Home.

Hand-written wiki content is never overwritten or regenerated — only its navigation is derived automatically.

MCP bundle

docs/mcp/** is a self-contained, machine-readable reference generated from docforge's own GSDFC docstrings. doc-forge serve --mcp --module docforge serves it over MCP. See the MCP Guide.