스핑크스로 장고 문서 자동화하기

Question

Sphinx를 사용하여 장고 프로젝트의 문서를 생성하고 있으며 실제로 잘 작동하고 있습니다. 그러나 .rst 파일을 직접 작성해야 할 필요가있는 것 같습니다. 일단 완료되면, sphinx는 HTML 작성을 실행할 때 문서화 문자열에서 문서를 컴파일합니다.

내 질문 : .rst 파일을 수동으로 편집 할 필요없이 프로젝트에 새로운 추가 사항을 자동으로 반영하도록 문서를 찾고 있습니다.

Django의 모든 것이 너무 단순 해 보이기 때문에 전체 프로젝트의 첫 번째 파일을 수동으로 만들어야한다는 것은 이상한 일입니다. 이미 존재하는 것이 있다고 생각했을 것입니다. 자동으로 구조를 검사합니다. 프로젝트, 그리고 그것의 첫 번째 빌드.

저는이 프로젝트에서 유망 해 보이는 http://pypi.python.org/pypi/django-sphinx-autodoc/0.0을 보았습니다. 그러나 더 성숙한 것이 없다는 사실에 놀랐습니다.

Answer 1

잠시 동안, Sphinx apidoc은 스핑크스로 번들되었습니다. 이 파일을 사용하면 .rst 개의 전체 파일을 만들 수 있습니다.

한 사이트에서 사용하는 다양한 장고 응용 프로그램을 모두 문서화하려는 경우 문제가됩니다 (원하는 내용 인 것 같습니다). Sphinx apidoc은 여러 디렉토리에서 python 패키지를 검색하려고합니다.