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
This commit is contained in:
@@ -8,11 +8,14 @@ A docs build runs through the CLI in a single pass.
|
||||
# Library reference only
|
||||
doc-forge build --mkdocs --module docforge
|
||||
|
||||
# Wik + library combined (single MkDocs build)
|
||||
# Wiki + library combined (single MkDocs build)
|
||||
doc-forge build --wiki --mkdocs --module docforge
|
||||
|
||||
# Wiki only — no module required
|
||||
doc-forge build --wiki --site-name docforge
|
||||
|
||||
# MCP structured bundle
|
||||
doc-forge build --mcp --module docforge
|
||||
```
|
||||
|
||||
## What a combined build does
|
||||
@@ -29,5 +32,12 @@ doc-forge build --wiki --site-name docforge
|
||||
|
||||
```bash
|
||||
doc-forge build --wiki --mkdocs --module docforge
|
||||
doc-forge serve --mkdocs-yml mkdocs.yml
|
||||
doc-forge serve --mkdocs --mkdocs-yml mkdocs.yml
|
||||
```
|
||||
|
||||
## Serve the MCP bundle
|
||||
|
||||
```bash
|
||||
doc-forge build --mcp --module docforge
|
||||
doc-forge serve --mcp --module docforge
|
||||
```
|
||||
Reference in New Issue
Block a user