How is this different from autoprogram?

alex-rudakov / sphinx-argparse

Sphinx extension that automatically document argparse commands and options

MIT License

49 stars 40 forks source link

How is this different from autoprogram? #16

Closed mr-c closed 10 years ago

mr-c commented 10 years ago

https://pythonhosted.org/sphinxcontrib-autoprogram/

alex-rudakov commented 10 years ago

For now sphinx-argparse is more feature rich:

allows to extend output of generated commands
more control over subcommands
better formating
improved support for man pages - was contributed recently
we have more contributors (see changelog)

Our extension was started far before autoprogram. If, at the time when I initiated the project, there would be at least something like autoprogram, then I wouldn't start my own extension.

mr-c commented 10 years ago

Cool, thanks for the summary. Perhaps you can get this package mentioned in the Sphinx docs to aid discovery. I'll give it a whirl soon. On Jul 31, 2014 12:49 AM, "Alex Rudakov" notifications@github.com wrote:

For now sphinx-argparse is more feature rich:

allows to extend output of generated commands

more control over subcommands

better formating

improved support for man pages - was contributed recently

we have more contributors (see changelog)

Our extension was started far before autoprogram. If, at the time when I initiated the project, there would be at least something like autoprogram, then I wouldn't start my own extension.

— Reply to this email directly or view it on GitHub https://github.com/ribozz/sphinx-argparse/issues/16#issuecomment-50712284 .

alex-rudakov commented 10 years ago

Added note about this package to the docs.

asmeurer commented 10 years ago

My take on this (I've only looked at each a little bit so far):

I disagree that the output format of sphinx-argparse is better. It uses tables, which aren't easy to read, and don't handle long option help text well (they scroll off in a frame and wrap weird, at least in the theme I'm using).
autoprogram doesn't handle argparse.SUPPRESS
It's annoying to use either with my existing code, as I don't already have a function that returns a parser. sphinx-argparse is better here because it allows a function, whereas autoprogram expects the parser to be in the module namespace.

Can you explain what the manpage support is?