Automate CLI reference documentation generation

[jenna-winkler]

Problem

Currently, our CLI reference documentation requires manual updates and can become outdated or incomplete. Developers need an easy way to access comprehensive CLI documentation that stays in sync with the actual CLI implementation.

Proposed solution

@jezekra1 mentioned there is a tool for this that generates the full docs page in markdown -- and this is an approach we used with BAM. Let's consider implementing this for CLI reference + see if we can use this same tool for other doc references like SDK.

[tomkis]

We are using typer library for CLI app. There's a CLI tool to generate docs https://typer.tiangolo.com/tutorial/typer-command/?h=docs#sample-script-with-docs.

We need to investigate if this does not interfere with our extended implementation AsyncTyper

can you investigate and propose solution @dosu?

[dosubot]

Based on the code, AsyncTyper is a thin subclass of Typer that preserves the Typer app interface and command registration, only adding async support and enhanced error handling. It uses functools.wraps to preserve function signatures and metadata, so Typer's doc generation tool (typer utils docs) should be able to introspect commands and generate accurate documentation as expected. There are no signs of incompatibility or relevant issues in the repo—AsyncTyper defers to Typer for command registration, so CLI metadata remains intact and documentable (source).

To confirm, run typer utils docs against your CLI entry point. If the docs generate as expected, you can automate this step in your CI or release process. If you encounter issues, they will likely be minor and can be addressed by ensuring your CLI entry exposes the Typer app instance as usual.

It's a good idea to re-check compatibility with future Typer releases, as async support and subclassing may evolve.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}