のpythonのreST形式のドキュメンテーション文字列

Question

をレンダリングすることはできません私は、Pythonのフレームワークを勉強scrapyと私はすべてのそれらの特殊文字は何をすべきか疑問に思ったか、意味

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. 

以下のように、それはドキュメンテーション文字列のスタイルを使用していることを学びました。私はthis articleに来て、ちょっとreST形式が何であるか曖昧な考えがありました。このdocstringがレンダリングされる方法を知りたかったので、これを試しましたonline rendererしかしdoctstringを適切にレンダリングしませんでした。クラス：：それはのようなものをサポートしていませんでしたように見えたと：メタ：

私の質問は、なぜ私はドキュメンテーション文字列をレンダリングすることができませんでした

• です。それは有効なreST形式ではありませんか？
• このスタイルのドキュメントストリングはまったくレンダリングされていないのですか？または
  プレーンテキストとして読み込む必要がありますか？
• できればこれをどのようにレンダリングできますか？
• インタラクティブなPythonシェルでレンダリングされたドキュメントストリングを使用できますか？

Answer 1

なぜドキュメントストリングをレンダリングできませんでしたか。それは有効なreST形式ではありませんか？

残りは有効ですが、それはどのようなhttp://rst.ninjs.org/レンダラサポート（Docutilsが提供することuses rst2html.py、）である「標準のreST」の一部ではないマークアップが含まれています。

:class:および:meth:は、標準reSTの追加例であり、Sphinxドキュメントジェネレータが理解しているものです。 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を参照してください。

このスタイルのドキュメントストリングは、まったくレンダリングされていませんか？それともプレーンテキストとして読まれるべきですか？

できればどうすればいいですか？

docstringはSphinxによって処理されるはずです。

インタラクティブなPythonシェルでレンダリングされたドキュメントストリングを使用できますか？

私は、コンソール出力をより良くするものを実装することは可能ですが、これを行うツールやライブラリはわかりません。