python doc для docstring

Question

Я хочу иметь инструмент, который может генерировать документацию из комментариев исходного кода, я нашел инструмент с именем pythondoc, он может генерировать HTML или XML из исходных кодов python, но он не поддерживает извлечение docstring , поддерживает только extrats комментарии '#', есть ли инструмент, который может поддерживать извлечение docstring?

Answer 1

Вы можете легко сканировать все файлы и папки, найти все файлы питона, и получить только строки документации из них с какой-то совпадения регулярных выражений, что-то вроде этого:

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))