2012-10-26 4 views
4

나는 sphinx-apidoc를 사용하는 매우 큰 코드 기반에서 Python 소스의 docstrings에서 HTML 문서를 자동으로 생성하려고합니다.Python Sphinx 문서를 데이터 전용 형식으로 가져 오는 방법은 무엇입니까?

: PARAM 메시지 : 입력 메시지 : 문자열
: 반환 : 메시지가
표시 형식의 문자열을
: RTYPE : 문자열이이 요구되고있다

이를 대체 할 수있는 문서화 문자열은 다음 형식을 사용 Sphinx HTML 문서는 다른 방식으로 구성/제시된 것이지만, 우리는 여전히 소스 코드에서 자동 생성을 원합니다. 스핑크스와 같은 중개자 (XML과 같은) 형식으로 문서를 생성 할 수있는 방법이 있습니까? 나는 이것을 할 수있는 방법을 찾지 못했습니다. 누구든지 내가 뭘할지 알아?

답변

6

구문 분석 가능한 JSON 출력을 생성하는 HTML 빌더 대신 'json'빌더를 사용할 수 있습니다. 원하는 양식을 작성하기 위해 빌더를 작성할 수도 있습니다 (현재 빌더 목록은 http://sphinx.pocoo.org/builders.html 참조).

관련 문제