sphinxcontrib-coffee

sphinxcontrib - 커피 스핑크스에 autodoc를 지원하는 커피 스크립트 도메인을 추가하는 스핑크스의 확장입니다.
이것은``.coffee`` 파일에서 소스 주석을 추출 coffeedoc_에 의존한다. 전 세계적으로 coffeedoc를 설치하려면 ::
& NBSP; NPM -g coffeedoc 설치
.. _coffeedoc : https://github.com/omarkhan/coffeedoc
용법
먼저 conf.py의 확장 목록에 확장자를 추가해야합니다 :
& NBSP; 확장 = [ 'sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
파이썬은 당신의 소스가 어디 있는지에 대한 단서가 없기 때문에, 어디 다음처럼 conf.py 보면하는 방법을 알려 주어야합니다 :
& NBSP; coffee_src_dir = os.path.abspath ( '../')
프로젝트가 주로 커피 스크립트의 경우 마지막으로, 당신은뿐만 아니라 기본 도메인을 정의 할 수 있습니다 :
& NBSP; primary_domain = '커피'
지침 및 역할
이 도메인 상호 참조에 대한 모듈, 함수, 클래스 및 방법 지침뿐만 아니라 메타, 클래스 및 FUNC 역할을 제공합니다. 모듈 이름, 이중 콜론, 모듈 내에서 객체로 점 별도의 경로 : 다른 객체를 참조하기 위해서는, 완전한 이름의 사용합니다.
커피 : FUNC :`lib 디렉토리 / 위젯 :: swizzle`` 예를 들어, 파일``lib 디렉토리 / widgets.coffee``,``쓰기에``swizzle`` 함수를 참조하십시오. 기본 도메인이 커피에 설정되어있는 경우 coffee``, 당신은``lib 디렉토리 / widgets`` 모듈 내에서 연결하는 IFF에 당신은 모듈 이름을 삭제할 수 있습니다 : 당신은 선두를``드롭 할 수 있습니다.
Autodoc
당신은 쉽게``automodule``과 전체 모듈을 문서화 할 수 있습니다 :
.. 소스 코드 :: 첫
& NBSP; .. automodule :: 인 MyModule
& NBSP; & nbsp; & nbsp; 확인 : 회원 :

이 요구 사항 :

이 파이썬