Auto-produce CLI documentation

[thcrock]

I don't have a fully formed version of this idea but here goes...

Should argcmdr be able to produce documentation for inclusion on doc sites? It seems helpful to show off the capabilities of a CLI produced with argcmdr, and to be able to do so while staying up to date with what's actually in there.

There are certainly complications, such as that documentation can be in many different formats and argcmdr doesn't necessarily need to be opinionated about them. But is there a way to just make this easier for a project that uses argcmdr?

[jesteria]

Sounds like a good idea to me.

I see that a sphinx plugin for argparse exists [docs]. We could document and/or add a utility to aid integration with this, likely pretty easily.

For targets outside of sphinx, I'm not yet sure – we'd have to do some investigation.

(To note, this is similar to, but certainly distinct from, #14.)