sphinx-contrib / autoprogram

Documenting CLI programs
https://pypi.org/project/sphinxcontrib-autoprogram/
Other
44 stars 23 forks source link

autoprogram vs argdoc #23

Open kiteloopdesign opened 4 years ago

kiteloopdesign commented 4 years ago

How does autoprogram compare against argdoc?

https://github.com/sphinx-contrib/argdoc

It looks like argdoc is not supported anymore and the recommended way to go is autoprogram?

Thanks!

langston-barrett commented 3 years ago

I'm not familiar with argdoc, but I'd welcome contributions of documentation on this front from anyone who is! In the meantime, I'll add a list of "related projects" somewhere to the documentation and put argdoc on it.

vbrozik commented 3 years ago

I would not use argdoc as it has not been touched for 6 years.

But it seems that pretty popular is sphinx-argparse https://github.com/alex-rudakov/sphinx-argparse which which is probably an older project than autoprogram. Here is an old comparison: https://github.com/alex-rudakov/sphinx-argparse/issues/16