Django admin documentation generator가 모델 용 Docstrings을 포맷하지 않았습니다.

Question

현재 Django 관리자 문서 생성기를 사용하여 모든 장고보기 및 모델을 문서화하는 중입니다. 모든 문서화 뷰에서 아무런 문제가 없었지만 내 모델의 문서화 문자열에 기록 된 것은 문서의 일반 텍스트로 렌더링됩니다. 즉

, 내가보기를 참조 할 경우 :

:view:`appname.view_name` 

이 뷰의 문서화 문자열에 삽입 된 경우 링크 (내가 원하는)로 렌더링되지만 "로 표시됩니다 : view :`appname.view_name` "을 어떤 모델의 문서화 문자열에 삽입하면 일반 텍스트로 보입니다. 그러나 모델의 메서드에서 삽입 할 때 서식을 다시 예상대로 작동합니다.

처음에는 이것이 문서 생성기의 단점이라고 생각했는데 모델 문서화를위한 마크 업을 읽지는 않았지만 문서 (여기에서 찾을 수 있습니다 : https://docs.djangoproject.com/en/1.5/ref/contrib/admin/admindocs/#model-reference)를 읽은 후에는 내가 할 수 있어야합니다. 문서의 다른 부분에 링크하십시오.

이 문제를 겪고있는 다른 사람을 본 적이 없으며 해결책을 찾기 시작할 곳이 어디인지 알지 못합니다. 모든 전문 지식과 설명에 미리 감사드립니다.

는

편집 : - 그것은 구조 조정 텍스트를 무시 즉 포맷이 모델의 문서화 문자열에 완전히 생략처럼

보인다. 예를 들어

는

클래스 MyModel (models.Model) :

"" "

제목

" ""

는 제목으로 간단하게 표시됩니다 django에서 일반 텍스트로 admin docs.

Answer 1

현재 장고 관리 문서 생성기 (작성 당시 1.7)는 모델 docstrings의 reStructure 텍스트를 지원하지 않습니다.

이것은 카드 #5405에서 처리되었지만 일부 병합 충돌을 만들었으므로 여전히 마스터에 병합되지 않았습니다. 마지막 변경 :

나는 풀 요청에 대한 의견을 남겼지만 깨끗하게 병합하려면 리베이스를 포함하여 약간의 개선이 필요합니다. 또한 릴리스 정보의 변경 사항을 언급하는 것이 좋습니다.