alex-rudakov / sphinx-argparse

Sphinx extension that automatically document argparse commands and options
MIT License
49 stars 40 forks source link

Rendering of triple-quoted lines as "definition" #63

Open rjplevin opened 7 years ago

rjplevin commented 7 years ago

I just updated sphinx-argparse and see that long argument help strings (which I typically triple-quote) are being rendered as "definition", i.e., bold first line followed by indented subsequent lines. Argparse, of course, handles these by changing interior sequences of white space to a single blank.

I think this extension should handle long strings the same way argparse does, or at least do so optionally.

Thanks, Rich

Phlya commented 4 years ago

Agree - at the same time single-line help strings are treated as descriptions, not definitions, which is counter-intuitive for me.