docs: nest generated docs under docs/lib and docs/mcp

This commit is contained in:
2026-09-10 21:15:05 +05:30
parent 0efe68b052
commit 658a98cf19
69 changed files with 8566 additions and 1882 deletions

View File

@@ -0,0 +1,65 @@
{
"module": "openapi_first.cli",
"content": {
"path": "openapi_first.cli",
"docstring": "Command-line interface for FastAPI OpenAPI-first scaffolding utilities.\n\n---\n\n## Summary\n\nThis CLI bootstraps OpenAPI-first FastAPI applications from versioned,\nbundled templates packaged with the library.",
"objects": {
"argparse": {
"name": "argparse",
"kind": "alias",
"path": "openapi_first.cli.argparse",
"signature": "<bound method Alias.signature of Alias('argparse', 'argparse')>",
"docstring": null
},
"shutil": {
"name": "shutil",
"kind": "alias",
"path": "openapi_first.cli.shutil",
"signature": "<bound method Alias.signature of Alias('shutil', 'shutil')>",
"docstring": null
},
"resources": {
"name": "resources",
"kind": "alias",
"path": "openapi_first.cli.resources",
"signature": "<bound method Alias.signature of Alias('resources', 'importlib.resources')>",
"docstring": null
},
"Path": {
"name": "Path",
"kind": "alias",
"path": "openapi_first.cli.Path",
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
"docstring": null
},
"DEFAULT_TEMPLATE": {
"name": "DEFAULT_TEMPLATE",
"kind": "attribute",
"path": "openapi_first.cli.DEFAULT_TEMPLATE",
"signature": null,
"docstring": null
},
"available_templates": {
"name": "available_templates",
"kind": "function",
"path": "openapi_first.cli.available_templates",
"signature": "<bound method Function.signature of Function('available_templates', 20, 33)>",
"docstring": "Return a list of available application templates.\n\nReturns:\n list[str]:\n Sorted list of template names found in the internal templates directory."
},
"copy_template": {
"name": "copy_template",
"kind": "function",
"path": "openapi_first.cli.copy_template",
"signature": "<bound method Function.signature of Function('copy_template', 36, 64)>",
"docstring": "Copy a bundled OpenAPI-first application template into a directory.\n\nArgs:\n template (str):\n Name of the template to copy.\n target_dir (Path):\n Filesystem path where the template should be copied.\n\nRaises:\n FileNotFoundError:\n If the requested template does not exist."
},
"main": {
"name": "main",
"kind": "function",
"path": "openapi_first.cli.main",
"signature": "<bound method Function.signature of Function('main', 67, 196)>",
"docstring": null
}
}
}
}