python - Python docstring が保存されているかどうかを確実に検出する方法は?

Question

私はdocstringビューアを開発しているので、docstringを見栄えの良いhtmlに適切に変換したいと思います。

ほとんどの標準ライブラリの docstring はreSTにはありませんが、大部分がnumpydoc標準を採用している科学ライブラリには当てはまりません。

したがって、docstring が reST にあるかどうかを確実に検出して、別のレンダーに渡す必要があります。

Answer 1

ReST は可能な限り読みやすいプレーン テキストのように見えるようにするフォーマットであるため、ドキュメント文字列のような小さなものは言うまでもなく、テキストの一部が ReST を使用しているかどうかを検出する信頼できる方法はありません。

ReSTとしてレンダリングしてみて、エンドユーザーにそれを再びオフにするオプションを与えるべきだと思います。