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:
@@ -2,6 +2,16 @@
|
||||
# Summary
|
||||
|
||||
Utilities for working with MCP in the doc-forge CLI.
|
||||
|
||||
---
|
||||
|
||||
Notes:
|
||||
- `generate_resources` produces the bundle consumed by `MCPServer`:
|
||||
`index.json`, `nav.json`, and per-module resources under `modules/`.
|
||||
- Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,
|
||||
and `docs://modules/{module}`.
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
@@ -26,7 +36,7 @@ def generate_resources(module: str, project_name: str | None, out_dir: Path) ->
|
||||
Python module import path used as the entry point for
|
||||
documentation generation.
|
||||
|
||||
project_name (Optional[str]):
|
||||
project_name (str | None):
|
||||
Optional override for the project name used in generated
|
||||
documentation metadata.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user