Django보기의 docstring 형식 지정 방법

Question

프로젝트에서 간단한보기를 사용하면 프로젝트가 더 커지기 시작합니다. 스핑크스 문서를 작성하고 docstrings 객체를 sphinx.ext.autodoc과 함께 사용합니다.

제 문제는 뷰의 문서화 문자열을 크게 포맷하는 방법입니다.

• 문서 GET/POST 및 기타 동작.
• 템플릿 (들)은 예를 들어
• 상황에 맞는 내용

를 사용, 내가 사용하고 있습니다 :

def my_view(request): 
    """ 
    Do something depending of HTTP method. 

    In GET: Returns a page 
    IN POST: Make something and redirect 

    GET parameters: 
    GET['next'] : URL to redirect to after submit form 

    POST parameters: 
    POST['action'] : Action 
    """ 

I 해요 자기 질문이 할 수있는 더 좋은 방법이 있는지? 그것에 대해 합의가 있습니까? 당신이 여기에서 찾을 수 있습니다

Answer 1

몇 가지 예 : 이 https://docs.djangoproject.com/en/1.8/ref/contrib/admin/admindocs/