無法呈現python reST格式文檔字符串

Question

我正在研究python框架，scrapy，我了解到它使用了如下所示的docstring樣式

class CrawlerRunner(__builtin__.object)
 |  This is a convenient helper class that keeps track of, manages and runs
 |  crawlers inside an already setup Twisted `reactor`_.
 |  
 |  The CrawlerRunner object must be instantiated with a
 |  :class:`~scrapy.settings.Settings` object.
 |  
 |  __init__(self, settings=None)
 |  
 |  crawl(self, crawler_or_spidercls, *args, **kwargs)
 |      Run a crawler with the provided arguments.
 |      
 |      It will call the given Crawler's :meth:`~Crawler.crawl` method, while
 |      keeping track of it so it can be stopped later.

我想知道所有這些特殊字符的作用或含義。 我看了這篇文章 ，對哪種reST格式有點含糊的想法。 我想知道應該如何渲染此文檔字符串，因此嘗試了此在線渲染器 ，但未正確渲染該文檔字符串。 似乎它不支持諸如：class：和：meth：

我的問題是

• 為什么我不能渲染文檔字符串。 它不是有效的reST格式嗎？
• 難道根本不應該渲染這種樣式的文檔字符串嗎？ 要么
  應該將其閱讀為純文本嗎？
• 如果可以的話，該如何渲染？
• 是否可以在交互式python shell中呈現docstring？

Answer 1

為什么我不能渲染文檔字符串。 它不是有效的reST格式嗎？

reST是有效的，但是它包含的標記不是“標准reST”的一部分，這是http://rst.ninjs.org/渲染器支持的標記（它使用 Docutils提供的rst2html.py）。

:class:和:meth:是Sphinx文檔生成器可以理解的標准reST附加示例。 參見http://www.sphinx-doc.org/en/stable/markup/index.html和http://www.sphinx-doc.org/en/stable/domains.html 。

以下標記，

:class:`~scrapy.settings.Settings`

呈現為scrapy.settings.Settings類文檔的超鏈接。 請參閱https://doc.scrapy.org/en/1.3/topics/api.html#scrapy.crawler.CrawlerRunner 。

難道根本不應該渲染這種樣式的文檔字符串嗎？ 還是應該將其閱讀為純文本？

如果可以的話，該如何渲染？

該文檔字符串應該由Sphinx處理。

是否可以在交互式python shell中呈現docstring？

我想可以實現使控制台輸出更好的東西，但是我不知道執行此操作的任何工具或庫。