falkcorp/Documentation Generator

Generate API and workflow documentation from source code and GitHub Actions workflows

Trust Signals

name	description	required	default
source-dirs	Comma-separated list of source directories containing Python modules to document. Each directory will be scanned recursively for .py files.	no	.github/workflows/scripts
workflows-dir	Directory containing GitHub Actions workflow YAML files (.yml, .yaml). Used to generate workflow reference documentation.	no	.github/workflows
output-dir	Root directory where documentation will be generated. Creates subdirectories for API docs, workflows, and search index.	yes	—
doc-version	Documentation version string (e.g., "1.0.0", "latest", "stable-v2"). If not provided, derives from environment or defaults to "latest".	no	""
generate-api	Whether to generate API documentation from Python docstrings.	no	true
generate-workflows	Whether to generate workflow reference documentation.	no	true
generate-search-index	Whether to generate a search index JSON file for documentation site integration.	no	true

name	description
build-status	Build status result. One of: success, partial, failed.
generated-files	JSON array of paths to generated documentation files.
api-docs-count	Number of API documentation files generated.
doc-version	The resolved documentation version used for this build.
output-dir	The absolute path to the documentation output directory.
search-index-path	Path to the generated search index JSON file (if enabled).