doc changes

This commit is contained in:
2026-01-21 17:36:08 +05:30
parent e33133cb0e
commit 15c59ab274
13 changed files with 110 additions and 36 deletions

View File

@@ -140,43 +140,43 @@
"name": "generate",
"kind": "function",
"path": "docforge.cli.main.generate",
"signature": "<bound method Function.signature of Function('generate', 78, 118)>",
"signature": "<bound method Function.signature of Function('generate', 82, 122)>",
"docstring": "Generate Markdown source files for the specified module.\n\nArgs:\n module: The primary module path to document.\n project_name: Optional project name override.\n docs_dir: Directory where documentation sources will be written."
},
"generate_mcp": {
"name": "generate_mcp",
"kind": "function",
"path": "docforge.cli.main.generate_mcp",
"signature": "<bound method Function.signature of Function('generate_mcp', 125, 164)>",
"signature": "<bound method Function.signature of Function('generate_mcp', 129, 168)>",
"docstring": "Generate MCP-compatible documentation resources for the specified module.\n\nArgs:\n module: The primary module path to document.\n project_name: Optional project name override.\n out_dir: Directory where MCP resources will be written."
},
"build": {
"name": "build",
"kind": "function",
"path": "docforge.cli.main.build",
"signature": "<bound method Function.signature of Function('build', 171, 192)>",
"signature": "<bound method Function.signature of Function('build', 175, 196)>",
"docstring": "Build the documentation site using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
},
"serve_mcp": {
"name": "serve_mcp",
"kind": "function",
"path": "docforge.cli.main.serve_mcp",
"signature": "<bound method Function.signature of Function('serve_mcp', 199, 226)>",
"signature": "<bound method Function.signature of Function('serve_mcp', 203, 230)>",
"docstring": "Serve MCP documentation from the local mcp_docs directory."
},
"serve": {
"name": "serve",
"kind": "function",
"path": "docforge.cli.main.serve",
"signature": "<bound method Function.signature of Function('serve', 233, 256)>",
"signature": "<bound method Function.signature of Function('serve', 237, 260)>",
"docstring": "Serve the documentation site with live-reload using MkDocs.\n\nArgs:\n mkdocs_yml: Path to the mkdocs.yml configuration file."
},
"main": {
"name": "main",
"kind": "function",
"path": "docforge.cli.main.main",
"signature": "<bound method Function.signature of Function('main', 263, 267)>",
"docstring": "CLI Entry point."
"signature": "<bound method Function.signature of Function('main', 267, 271)>",
"docstring": "CLI Entry point. Boots the click application."
}
}
},