【发布时间】：2012-02-18 02:47:12
【问题描述】：
当您键入以下内容时，是否有办法让 IPython 完全呈现 reStructuredText（用于 Sphinx）文档字符串：
help foo
或：
foo?
当 IPython 显示原始标记时，我发现尝试阅读 IPython 中的帮助文档会让人分心超级。 reST 非常适合 Sphinx 文档，但确实会混淆简单的帮助查找。我不能一个人在这件事上......？
Google 在这方面没有任何帮助。
【问题讨论】：
-
据我所知，还没有。欢迎投稿 - 在邮件列表或 IRC 上询问从哪里开始。
-
添加该功能的一种方法是将文档字符串呈现为 HTML，然后对输出进行解析和着色（或仅打印文本）。
-
还有一个用于 Sphinx 的文本生成器，可能比使用 HTML 更容易。
-
我同意，在 ipython 中查看 sphinx 文档字符串并不是人类可读的。我尝试使用“合并字段”作为折衷方案：在解释器中查看文档字符串更好，但 Sphinx 的一些不错的功能丢失了。
-
感谢您的链接 - 非常鼓舞人心。我认为 Brian Granger 说得最好：“就个人而言，如果笔记本能够处理 markdown+latex 文档字符串，我将永远不会在任何新项目中使用 reST。”我已经在文档字符串中使用 Markdown 而不是 Sphinx，因为我看到一些项目旨在从文档字符串构建 API 文档。我认为，这是我目前唯一需要 Sphinx 的东西。
标签： python ipython python-sphinx restructuredtext docstring