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:
@@ -49,7 +49,7 @@ class MCPRenderer:
|
||||
nav.append(
|
||||
{
|
||||
"module": module.path,
|
||||
"resource": f"doc://modules/{module.path}",
|
||||
"resource": f"docs://modules/{module.path}",
|
||||
}
|
||||
)
|
||||
|
||||
@@ -101,7 +101,7 @@ class MCPRenderer:
|
||||
Module instance to convert.
|
||||
|
||||
Returns:
|
||||
Dict:
|
||||
dict:
|
||||
Dictionary representing the module and its documented objects.
|
||||
"""
|
||||
data: dict = {
|
||||
@@ -124,7 +124,7 @@ class MCPRenderer:
|
||||
Documentation object to convert.
|
||||
|
||||
Returns:
|
||||
Dict:
|
||||
dict:
|
||||
Dictionary describing the object and any nested members.
|
||||
"""
|
||||
data: dict = {
|
||||
@@ -149,7 +149,7 @@ class MCPRenderer:
|
||||
Serialize data to formatted JSON.
|
||||
|
||||
Args:
|
||||
data (Dict):
|
||||
data (dict):
|
||||
Dictionary to serialize.
|
||||
|
||||
Returns:
|
||||
|
||||
Reference in New Issue
Block a user