feat: Initial automation for cli options

[debermudez]

No description provided.

[github-actions]

Try out this PR

Quick install:

pip install --upgrade --force-reinstall git+https://github.com/ai-dynamo/aiperf.git@dbermudez/automate-cli-doc-gen

Recommended with virtual environment (using uv):

uv venv --python 3.12 && source .venv/bin/activate
uv pip install --upgrade --force-reinstall git+https://github.com/ai-dynamo/aiperf.git@dbermudez/automate-cli-doc-gen

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[ajcasagrande]

@debermudez I have something for this already as well

I was also holding off as v4 cyclopts supposedly might have this already.

https://github.com/ai-dynamo/aiperf/blob/ajc/gen-help/tools/generate_cli_docs.py

I also waffle back and forth over the format:
https://github.com/ai-dynamo/aiperf/blob/ajc/gen-help/docs/cli_options.md

[debermudez]

Yea. I recall talking thru that but the docs are getting out of date in the mean time.
I dont love the format yet, which is why its still a draft, but I think we need to do something here to avoid the accumulation of tech debt and subsequent engineering effort.