如何使用Sphinx进行“实时”Python代码示例?

时间:2013-06-02 00:33:41

标签: python python-sphinx

如何在某些功能的Sphinx文档中包含实时代码示例?我似乎无法找到一个让我做类似

的指令
def muffin_button(n):
    '''
    This function prints *n* muffins.  For example, ``muffin_button(3)`` gives:

    .. <some directive>::

        muffin_button(3)
    '''
    print "Muffin! " * n

这样文档就像:

  

muffin_button 名词的)

     

此功能打印 n 松饼。例如,muffin_button(3)给出:

  Muffin! Muffin! Muffin!

我认为ipython directive可能有效,但似乎(?)就像它所做的一样是格式化你转储到指令中的会话输出。他们所有的例子都有输出硬编码;不是我想要的。

0 个答案:

没有答案