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:
|
||||
|
||||
@@ -54,7 +54,7 @@ class MkDocsRenderer:
|
||||
out_dir (Path):
|
||||
Directory where generated Markdown files will be written.
|
||||
|
||||
module_is_source (bool, optional):
|
||||
module_is_source (bool | None):
|
||||
If True, treat the specified module as the documentation root
|
||||
rather than nesting it inside a folder.
|
||||
"""
|
||||
@@ -87,11 +87,10 @@ class MkDocsRenderer:
|
||||
"""
|
||||
Generate a `README.md` file from the root module docstring.
|
||||
|
||||
Behavior:
|
||||
|
||||
- If `module_is_source` is True, `README.md` is written to the project
|
||||
root directory.
|
||||
- If False, README generation is currently not implemented.
|
||||
Notes:
|
||||
- If `module_is_source` is True, `README.md` is written to the
|
||||
project root directory.
|
||||
- If False, README generation is currently not implemented.
|
||||
|
||||
Args:
|
||||
project (Project):
|
||||
@@ -100,10 +99,10 @@ class MkDocsRenderer:
|
||||
docs_dir (Path):
|
||||
Directory containing generated documentation sources.
|
||||
|
||||
module_is_source (Optional[bool]):
|
||||
module_is_source (bool | None):
|
||||
Whether the module is treated as the project source root.
|
||||
|
||||
readme_dir (Optional[Path]):
|
||||
readme_dir (Path | None):
|
||||
Directory where the generated README.md should be written.
|
||||
Defaults to the parent of `docs_dir`.
|
||||
"""
|
||||
@@ -157,7 +156,7 @@ class MkDocsRenderer:
|
||||
Project model to inspect.
|
||||
|
||||
Returns:
|
||||
Optional[Module]:
|
||||
Module | None:
|
||||
The root `Module` if found, otherwise `None`.
|
||||
"""
|
||||
for module in project.get_all_modules():
|
||||
@@ -189,7 +188,7 @@ class MkDocsRenderer:
|
||||
out_dir (Path):
|
||||
Base directory for generated documentation files.
|
||||
|
||||
module_is_source (bool, optional):
|
||||
module_is_source (bool | None):
|
||||
Whether the module acts as the documentation root directory.
|
||||
"""
|
||||
|
||||
|
||||
Reference in New Issue
Block a user