xoa.cfgm.opt2rst

xoa.cfgm.opt2rst(shelp, prog=None, secfmt=':{secname}:', descname='Description')[source]

Convert –help str to rst

This is useful for autodocumenting executable python scripts that show a formatted help.

Parameters:

  • shelp (str) – Help string showing options (results from :option:--help).

  • prog (optional, str) – Program name, otherwise guess it from usage.

Returns:

str – String converted to rst format (with cmdoption directives).