Vishesh 'ironeagle' Bangotra
12a2493c6c
Some checks reported errors
continuous-integration/drone/push Build was killed
82 lines
3.1 KiB
JSON
82 lines
3.1 KiB
JSON
{
|
|
"module": "renderers.human-docs",
|
|
"content": {
|
|
"path": "renderers.human-docs",
|
|
"docstring": "",
|
|
"objects": {
|
|
"HumanDocsOptions": {
|
|
"name": "HumanDocsOptions",
|
|
"kind": "interface",
|
|
"path": "renderers.human-docs.HumanDocsOptions",
|
|
"signature": "HumanDocsOptions",
|
|
"docstring": "Generate the human-facing documentation site using TypeDoc.\n\nTypeDoc plays the same role for doc-weaver that MkDocs plays for\ndoc-forge: it renders the compiled model into a browsable site. The\nmachine-facing output (MCP JSON) is produced separately.",
|
|
"members": {
|
|
"entryPoints": {
|
|
"name": "entryPoints",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.entryPoints",
|
|
"signature": "entryPoints: string[]",
|
|
"docstring": ""
|
|
},
|
|
"entryPointStrategy": {
|
|
"name": "entryPointStrategy",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.entryPointStrategy",
|
|
"signature": "entryPointStrategy: \"resolve\" | \"expand\" | \"merge\" | \"packages\"",
|
|
"docstring": "TypeDoc entry-point strategy. Defaults to 'resolve'."
|
|
},
|
|
"name": {
|
|
"name": "name",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.name",
|
|
"signature": "name: string",
|
|
"docstring": ""
|
|
},
|
|
"options": {
|
|
"name": "options",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.options",
|
|
"signature": "options: string",
|
|
"docstring": "Optional path to a typedoc.json config."
|
|
},
|
|
"out": {
|
|
"name": "out",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.out",
|
|
"signature": "out: string",
|
|
"docstring": ""
|
|
},
|
|
"plugin": {
|
|
"name": "plugin",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.plugin",
|
|
"signature": "plugin: string[]",
|
|
"docstring": "Optional TypeDoc plugins (e.g. typedoc-plugin-markdown)."
|
|
},
|
|
"skipErrorChecking": {
|
|
"name": "skipErrorChecking",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.skipErrorChecking",
|
|
"signature": "skipErrorChecking: boolean",
|
|
"docstring": "Skip TypeScript error checking. Defaults to true."
|
|
},
|
|
"tsconfig": {
|
|
"name": "tsconfig",
|
|
"kind": "property",
|
|
"path": "renderers.human-docs.HumanDocsOptions.tsconfig",
|
|
"signature": "tsconfig: string",
|
|
"docstring": ""
|
|
}
|
|
}
|
|
},
|
|
"generateHumanDocs": {
|
|
"name": "generateHumanDocs",
|
|
"kind": "function",
|
|
"path": "renderers.human-docs.generateHumanDocs",
|
|
"signature": "generateHumanDocs(opts: HumanDocsOptions): Promise<string>",
|
|
"docstring": ""
|
|
}
|
|
}
|
|
}
|
|
}
|