[feature request]: automatic markdown documentation generation

[danielgafni]

A pretty useful feature Typer has is automatic documentation generation. It's really helpful to have this as part of pre-commit hooks and in the CI pipeline.

I wonder if cyclopts could also have this?

[BrianPugh]

I think we can do that! I think a limitation is that the output docs format will have to be the same format as App.help_format. I'll try and get to this!

[doodla]

@BrianPugh This feature would be very useful to us as we're building out a new CLI app. Were you able to chip away at this?

[BrianPugh]

I haven't started this effort yet; I'll begin it after I finish up my dictionary-support efforts.

[danielgafni]

Hey @BrianPugh, do you need help with this?
I would really like to switch to Cyclopts in my projects, this is the only thing holding me back.
Let me know if I could do anything.

[BrianPugh]

Thanks for offering! I'm in the middle of a big refactor that should make this feature pretty easy for a v3.0.0 cyclopts. Still targeting about a month away.