2010-01-07 55 views
3

如果此代碼在我的文檔中是一個塊引用,那麼在生成文檔時,我需要做些什麼才能使Sphinx運行它?我嘗試添加如何讓Sphinx測試嵌入在文檔中的代碼?

.. testcode:: 

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

到的.rst來源和獅身人面像的doctest擴展conf.py之一,但我得到了一個錯誤抱怨的函數體的第一行縮進意外。 Sphinx的doctest能夠運行文檔中定義的函數嗎?

+0

您是否閱讀過http://sphinx.pocoo.org/ext/doctest.html?你有什麼*具體*問題根據你讀的是什麼? – 2010-01-07 16:16:27

+0

細節改進。 – joeforker 2010-01-07 19:39:46

+0

由於testblock不是Sphinx指令,我不知道你認爲應該發生什麼。如果你的意思是'testcode',那麼你錯過了'testoutput'。如果你的意思是'doctest',那麼你錯過了所有預期的標點符號。 – 2010-01-08 03:19:04

回答

3

testcode指令需要匹配testoutput指令。

下面是文檔中的示例。

.. testcode:: 

    print 'Output  text.' 

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

    Output text.