python doc for docstring

Question

소스 코드 주석에서 문서를 생성 할 수있는 도구가 필요합니다. pythondoc이라는 도구를 발견했으며, python 소스 코드에서 HTML 또는 XML을 생성 할 수 있지만 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))