Documentación de Sphinx: ERROR: Directiva desconocida tipo "program-output"

Question

Estoy tratando de crear mis documentos con Sphinx, y ahora en dos máquinas tengo exactamente el mismo problema: la directiva program-output no funciona.

He instalado Esfinge, entonces la extensión programoutput:

$ sudo pip install sphinxcontrib-programoutput 

La instalación fue bien, los documentos compilan muy bien a buen html buscando, pero la salida del comando simplemente no funciona.

creé un caso super-sencilla prueba con un archivo llamado test.rst que contiene una sola línea:

.. program-output:: python -V 

Ahora cuando se trata de compilar este, me da la siguiente salida (ruta abreviado):

/path/to/test.rst:1: ERROR: Unknown directive type "program-output". 

Cambiar la salida del programa a su salida de comando de alias tampoco funciona (lo cual no es sorprendente). Realmente me pregunto qué estoy haciendo mal aquí. Seguí las instrucciones de instalación, lo intenté una y otra vez, reinstalé con una bandera --upgrade, nada funciona.

Answer 1

Gracias a bmu encontré el problema, de hecho tuve que agregarlo a la conf.py.

Ahora la siguiente pregunta: "¿por qué no está en la documentación de instalación/uso de esta extensión?" No se menciona en http://packages.python.org/sphinxcontrib-programoutput/, que es el primer enlace que obtengo cuando busco esta extensión en Google.

De todos modos la respuesta completa, espero que sea útil para otras personas también:

Ir a la raíz del documento de la documentación (por ejemplo ~/Projects/project-name/doc) donde el resto de sus documentos son.

Editar archivo conf.py

Busque la línea que dice extensions = [] (una lista vacía en mi caso)

Cambiar esto a: extensions = ['sphinxcontrib.programoutput']

y milagrosamente de repente empieza a trabajar.