小编use*_*990的帖子

使用Sphinx扩展自动生成doctest输出

我想我错过了关于doctest的sphinx扩展的一些内容.

文档中的典型示例是:

.. doctest::

   >>> print 1
   1
Run Code Online (Sandbox Code Playgroud)

有没有办法让sphinx 1自动生成输出(这里:) ?

据我所知,可以运行:

$ make doctest
Run Code Online (Sandbox Code Playgroud)

它具有测试代码片段的效果,并将实际输出与预期输出进行比较.例如,如果你有

.. doctest::

   >>> print 1
   3
Run Code Online (Sandbox Code Playgroud)

doctest会警告你1它正在期待它3.

相反,我希望sphinx在我的docstring或我的.rst文件中单独插入实际输出.例如,如果我们有类似的东西:

.. doctest::

    >>> print 1
    >>> print [2*x for x in range(3)]
Run Code Online (Sandbox Code Playgroud)

我希望当我们运行make doctest一个选项时,它会将docstring更改为:

.. doctest::

   >>> print 1
   1
   >>> print [2*x for x in range(3)]
   [0,2,4]
Run Code Online (Sandbox Code Playgroud)

我确信这是可能的,而且非常方便!

python doctest python-sphinx

8
推荐指数
2
解决办法
2974
查看次数

标签 统计

doctest ×1

python ×1

python-sphinx ×1