python - 从 epydoc 的文档字符串格式切换到 sphinx 文档字符串格式的自动方式？

Question

我有一个使用 epydoc 记录的项目。现在我正在尝试切换到狮身人面像。我为 epydocs 格式化了我所有的文档字符串，使用 B{}、L{} 等来加粗、链接等，并使用 @param、@return、@raise 等来解释输入、输出、异常等。

所以现在我改用 sphinx，它失去了所有这些功能。是否有一种自动方法可以将针对 epydocs 格式化的文档字符串转换为针对 sphinx 格式化的文档字符串？

Answer 1

为了扩展 Kevin Horn 的回答，可以在 autodoc-process-docstring 触发的事件处理程序中即时翻译文档字符串。事件。

下面是一个小演示(通过将代码添加到conf.py 来尝试)。它取代了一些常见的 Epytext fields 中的 @ 字符with :，在对应的Sphinx fields中使用.

import re

re_field = re.compile('@(param|type|rtype|return)') 

def fix_docstring(app, what, name, obj, options, lines):
    for i in xrange(len(lines)):
        lines[i] = re_field.sub(r':\1', lines[i])

def setup(app):
    app.connect('autodoc-process-docstring', fix_docstring)