¿Cómo llego Sphinx para probar código incrustado en la documentación?

Question

Si este código es un blockquote en mi documentación, ¿qué necesito hacer para que Sphinx plazo cuando se genera la documentación? He intentado añadir

.. testcode::

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

a una de las fuentes .rst y el Sphinx extensión doctest a conf.py, pero tengo un error quejándose de indentación inesperado en la primera línea del cuerpo de la función. Es doctest de Sphinx capaz de ejecutar funciones definidas en la documentación?

Answer 1

La directiva testcode necesita una directiva testoutput juego.

Aquí está el ejemplo de la documentación.

.. testcode::

   print 'Output     text.'

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

   Output text.