search

alex-rudakov / sphinx-argparse

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

Markdown -> RST Conversion #44

Closed sils closed 7 years ago

sils commented 7 years ago

We don't really wanna use rst for our main description, rather markdown which is optimized for plain text readability.

Would be nice to auto convert it to rst, see also http://api.coala.io/en/latest/Developers/coala_settings.html - maybe using pandoc or somethin'

dpryan79 commented 7 years ago

This isn't really related to sphinx-argparse, it just requires a tweak to your conf.py and installing a package. This also happens to be supported on readthedocs. Instructions are here, which I'll make reference to in the sphinx-argparse documentation.

dpryan79 commented 7 years ago

Ah, that's on a per-file basis. I'll see if I can something together to flag markdown to be sent through recommonmark first.

dpryan79 commented 7 years ago

This is now implemented in the develop branch and will be present in the next release.