如何可靠地检测python文档字符串是否处于静止状态?

时间:2012-11-07 20:37:57

标签: python restructuredtext

我正在开发一个docstring查看器,所以我想将任何文档字符串正确转换为好看的HTML。

大多数标准库中的文档字符串不在reST中,但对于大多数采用numpydoc标准的科学库来说情况并非如此。

所以我想可靠地检测docstring是否在reST中,以便将它传递给不同的渲染。

1 个答案:

答案 0 :(得分:3)

由于ReST是一种尽可能看起来像可读纯文本的格式,因此没有可靠的方法来检测是否有任何文本正在使用ReST,更不用说像文档字符串一样小的东西了。

我会说你应该尝试将其渲染为ReST,并为最终用户提供再次关闭它的选项。