RST docstrings


PyCharm does not appear to have any support for RST in docstrings beyond bolding definition keys (:param foo:).  What would be really helpful would be at least basic RST error checking (Unexpected indent,...).  A live docstring preview (like rsted,, which uses rst2html, would be awesome!  Currently having to write the docstring, copy it to rsted to verify the RST is valid, make any corrections, then copy the source back to the docstring.

A sweet bonus would be RST command completion in docstrings.

Thank you!
1 comment
Comment actions Permalink
Hi Roy,

Actually, we do use rst2html for the quick documentation view (Ctrl+Q)

I've created a feature request about error checking in our tracker –
Please, feel free to vote it and get notified while it's fixed.

Please sign in to leave a comment.