docs: Add comprehensive documentation to recipe generator

Add detailed docstrings and inline comments to all recipe generator modules explaining classes, functions, and complex logic in plain English.

Files updated:
- recipe-generator/recipe_generator.py: Module, class, and method docs
- recipe-generator/cli.py: CLI modes, arguments, and workflow docs
- recipe-generator/validators.py: Three-layer validation architecture docs
- recipe-generator/manifest.py: Manifest processing and variant expansion docs
- recipe-generator/generate_recipe.py: Entry point documentation
This commit is contained in:
Lukas Greve
2026-03-27 11:07:16 +01:00
parent 31955a8983
commit 0a3c2b14d8
5 changed files with 1052 additions and 113 deletions
+20 -2
View File
@@ -1,5 +1,23 @@
#!/usr/bin/env python3
"""Entry point for the recipe generator."""
"""Entry point for the recipe generator.
This is a simple wrapper script that provides the main entry point for running
the recipe generator. It follows the common Python pattern of having a script
that can be run directly or imported as a module.
Usage:
# Run as script
python generate_recipe.py --type virtual-desktop --version 43 --output output.cfg
# Or from another Python script
from generate_recipe import main
main()
This module doesn't do any processing itself - it delegates to the cli.main()
function which handles all the actual work. The separation allows for:
- Easy command-line execution (this file is the entry point)
- Module imports without triggering execution
- Clean separation of concerns (cli.py handles CLI, this just delegates)
"""
from cli import main