Executes the complete documentation compilation pipeline based on merged configurations.
Returns:
Exit code: 0 on success, non-zero on failure.
Methods
run_pipeline
run_pipeline(global_config_path: Optional, sdk_config_path: Optional, doc_config_path: Path, input_override: Optional, output_override: Optional, format_override: Optional, max_workers_override: Optional) -> int
Executes the complete documentation compilation pipeline based on merged configurations.
Returns:
Exit code: 0 on success, non-zero on failure.
| Parameter | Type | Description |
|---|---|---|
| global_config_path | Optional | Path to the global system configuration, or None to skip. |
| sdk_config_path | Optional | Path to the SDK/product metadata configuration, or None to skip. |
| doc_config_path | Path | Path to the target document configuration (e.g. ude_doc_config.json). |
| input_override | Optional | Optional override path for the source directory. |
| output_override | Optional | Optional override path for the output directory. |
| format_override | Optional | Optional override format (‘hugo_markdown’ or ‘html’). |
| max_workers_override | Optional |
Generated with Flude
Copyright © 2026