如何可靠地检测Python文档字符串是否为reStructuredText格式？

Question

4

我正在开发一个文档字符串查看器，因此我希望能够将任何文档字符串正确地转换为漂亮的HTML。

大多数标准库中的文档字符串不是reST格式，但科学库不是这种情况，它们大部分采用了numpydoc标准。

因此，我希望能够可靠地检测文档字符串是否为reST格式，以便将其传递给不同的渲染器。

- Carlos Cordoba

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Martijn Pieters · Accepted Answer

鉴于ReST是一种尽可能类似可读纯文本的格式，因此没有可靠的方法来检测任何文本块是否使用了ReST，更不用说像docstring这样小的东西了。

我建议您只需尝试将其呈现为ReST，并为最终用户提供关闭选项。