2010-01-07 3 views
3

이 코드가 내 설명서의 인용문 일 경우 Sphinx 설명서가 생성 될 때 실행하려면 무엇이 필요합니까? 나는 .rst 소스와 conf.py에 스핑크스 doctest가 확장 중 하나에Sphinx에서 문서에 포함 된 코드를 테스트하려면 어떻게해야합니까?

.. testcode:: 

    import datetime 
    def today(): 
     return datetime.datetime.now().date() 
    if True: 
     today() 

을 추가하는 시도,하지만 난 함수 본문의 첫 번째 줄에 예기치 않은 들여 쓰기에 대해 불평 오류를 얻었다. 스핑크스의 문서는 문서에 정의 된 기능을 실행할 수 있습니까?

+0

http://sphinx.pocoo.org/ext/doctest.html을 읽으셨습니까? 읽은 내용을 토대로 어떤 * 특정 * 질문을 했습니까? –

+0

특색이 개선되었습니다. – joeforker

+0

testblock은 Sphinx 지시어가 아니기 때문에 어떤 생각이 들지는 모르겠다. 'testcode'를 사용했다면'testoutput' 파일이 없습니다. 만약 당신이'doctest'를 의미한다면, 예상되는 모든 구두점을 놓치고 있습니다. –

답변

3

testcode 지시문은 일치하는 testoutput 지시문이 필요합니다.

다음은 설명서의 예입니다.

.. testcode:: 

    print 'Output  text.' 

.. testoutput:: 
    :hide: 
    :options: -ELLIPSIS, +NORMALIZE_WHITESPACE 

    Output text. 
관련 문제