provider_docs¶
Hook for extracting provider metadata for building docs.
Warning: Hook is experimental. Expect changes.
Inputs¶
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| path | str | . | False | The path to the provider. |
| output | str | . | False | The path to output the docs to. |
| provider | str | None | False | The provider name. |
| output_schemas | bool | False | False | Output the json schema instead. |
| hooks_dir | str | hooks | False | Directory hooks are in. |
Arguments¶
| Position | Argument | Type |
|---|---|---|
| 1 | path | str |
| 2 | output | str |
Returns¶
union - Returns a dictionary with metadata about a provider and it's hooks or a list of schemas when run with output_schemas.