<#966 Add extended documentation support to CLI op...
# flyte-github
a
#966 Add extended documentation support to CLI options Pull request opened by ppiegaze Summary • Adds
DocOption(click.Option)
subclass with a
docs
parameter for rich per-option markdown content • Extends
_render_command()
in the doc generator to emit per-option subsections (e.g.
#### --copy-style
) after the summary table • Adds
_docs.py
module with extended documentation constants for
flyte run
(11 options) and
flyte deploy
(9 options) •
docs
content appears only in
flyte gen docs
output, never in
--help
terminal output This enables the generated CLI reference (
flyte-cli.md
) to include detailed per-option documentation (usage examples, "how it works" sections, use cases) that was previously maintained as separate hand-written pages in the docs repo. Test plan •
flyte gen docs --type markdown
produces per-option
####
sections after summary tables •
flyte run --help
and
flyte deploy --help
output unchanged • All 186 CLI tests pass (
pytest tests/cli/
) • Regenerate
flyte-cli.md
in unionai-docs and verify rendered output 🤖 Generated with Claude Code flyteorg/flyte-sdk