스핑크스-HTTP-도메인은 편안하고 HTTP 메소드의 문서를 허용하는 HTTP 도메인을 추가하는 스핑크스 플러그인입니다.
당신은 곱슬 중괄호 경로에 인수를 마무리, 간단한 방법을 문서화 할 수 있습니다 :
.. HTTP : 방법 : GET / API / foo는 / 바 / {ID} / {슬러그}
& NBSP; ARG 자료 : ID
& NBSP; 인수 슬러그 : 슬러그
& NBSP; 지정된 ID와 일치하는 foobars의 목록을 검색합니다.
쿼리 문자열 매개 변수도 지원됩니다 :
.. HTTP : 방법 : GET / API / foo는 / 바 / ID
& NBSP; PARAM 자료 : ID
& NBSP; 지정된 ID와 일치 foobars의 목록을 검색합니다.
이 순간에 아주 초보적인 실험 코드입니다.
설치
스핑크스-HTTP-도메인을 설치 PIP 실행합니다.
그런 다음 conf.py에 sphinx_http_domain를 추가 :
확장 = [ 'sphinx_http_domain']
요구 사항 :
파이썬
스핑크스
댓글을 찾을 수 없습니다