简体   繁体   English

在iPython中查看reStructuredText(Sphinx)文档字符串?

[英]View reStructuredText (Sphinx) docstrings in iPython?

Is there a way to have IPython fully render reStructuredText (for Sphinx) docstrings when you type the following: 当您键入以下内容时,有没有办法让IPython完全呈现reStructuredText(对于Sphinx)文档字符串:

help foo

or: 要么:

foo?

I find it super distracting to try to read help docs in IPython when it shows the raw markup. 我觉得超级分心,试图读取IPython的帮助文档时,它显示了原始标记。 reST is great for Sphinx documentation, but really clutters up simple help lookups. reST非常适合Sphinx文档,但真正混乱了简单的帮助查找。 I can't be alone on this one...? 我不能孤身一人......?

Google has been no help on this one. 谷歌一直没有帮助。

I don't think it is possible in IPython, but have a look at Spyder : You can open an IPython console from within the IDE. 我认为在IPython中不可能,但是看看Spyder :你可以在IDE中打开一个IPython控制台。 Docstrings are rendered as HTML. 文档字符串呈现为HTML。

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM