在Sphinx文档中向交互式Python控制台块添加输出？

Question

如何将输出添加到Sphinx文档中的交互式Python控制台块？在

例如，我可以做一些类似的事情：

First set the variable::

    >>> x = 1

Then print the variable::

    >>> print x

并让Sphinx自动将print x的输出插入到文档中？在

我试过：

• sphinxcontrib-autorunhttps://pypi.python.org/pypi/sphinxcontrib-autorun/0.1-20140415-但是它在一个单独的interwriter中运行每个块
• IPython.sphinxext.ipython_directive-但它强制使用IPython语法，而不是“传统的”Python控制台。在

还有别的办法吗？在

Answer 1

为Sphinx编写扩展的文档位于http://sphinx-doc.org/extdev/index.html#dev-extensions

我唯一的提示是使用self.state.nested_parse(..)可以省去很多麻烦。这里是我拥有的最简单的扩展：

class SvnRevisionDirective(Directive):
    """Directive to display subversion revision of the path.
    """
    has_content = True
    required_arguments = 1
    optional_arguments = 1
    final_argument_whitespace = False
    option_spec = {}

    def run(self):
        path = self.arguments[0]
        rev = svntools.Revision(path)   # uses subprocess etc.
        paragraph = nodes.paragraph()
        self.state.nested_parse(
            StringList([
                '**Revision:** r%d' % rev   # you can use regular rst syntax here(!)
            ]), 0, paragraph)
        return [paragraph]

...

def setup(app):
    ...
    app.add_directive('svnrevision', SvnRevisionDirective)

它的用法是

^{pr2}$

Answer 2

好吧，我已经在这里做了一个：https://bitbucket.org/wolever/sphinx-contrib/src/tip/autorun2/?at=default