python - 用于文档字符串的 python doc

Question

我想要一个可以从源代码注释生成文档的工具，我找到了一个名为pythondoc的工具，它可以从python源代码生成HTML或XML，但它不支持提取文档字符串，只支持提取'# '评论，有没有可以支持文档字符串提取的工具？

Answer 1

您可以轻松扫描所有文件和文件夹，查找所有 python 文件，并通过一些正则表达式匹配仅从其中获取文档字符串，如下所示：

import re
import os
import xmlutils # download it from: https://gist.github.com/huseyinyilmaz/1448723

my_dir = '<absolute path to my dir>'

doc_dict = dict()

for root, dirs, files in os.walk(my_dir):
    for filename in files:
        if filename.endswith('.py'):
            with open(os.path.join(root, filename), 'r') as py_file:
                basename = os.path.basename(filename)
                doc_dict[basename] = [m.group('doc') for m in re.finditer(
                    re.compile(r'("|\'){3}(?P<doc>.*?)\1{3}', re.DOTALL),
                    py_file.read()
                )]

dict2xml(dict(root=doc_dict))