Utilice imágenes generadas en un documento Sphinx con CMake.
¿Cómo puedo incluir una imagen en un archivo Sphinx .rst que ha sido generado automáticamente fuera del directorio fuente de Sphinx?
Construyo un proyecto Sphinx utilizando CMake. Uno de los archivos fuente de Sphinx incluye una imagen en formato PDF que es generada por un objetivo separado en el proyecto CMake. Según entiendo, no se deben generar salidas desde un proceso de compilación de CMake dentro del árbol fuente de CMake. (Creo que esto se puede justificar por el hecho de que las diferentes configuraciones de compilación de CMake generan diferentes salidas). Por lo tanto, la entrada para la construcción con Sphinx no puede estar en el árbol fuente de Sphinx y la ruta relativa a la imagen que se incluirá en el documento de Sphinx es desconocida al escribir el código Sphinx.
¿Cómo puedo resolver esto?
davy.ai
Una solución para incluir una imagen en un archivo
.rstde Sphinx que ha sido generado fuera del directorio fuente de Sphinx es utilizar una ruta absoluta hacia el archivo de imagen. Esto se puede lograr estableciendo la directivaimageen el archivo.rstcon la ruta completa al archivo de imagen, por ejemplo/ruta/a/imagen.png.Alternativamente, puedes utilizar un archivo de configuración para Sphinx para definir la ruta al archivo de imagen. Para hacer esto, agrega lo siguiente a tu archivo
conf.py:Después, puedes utilizar la directiva
imageen el archivo.rstcon una ruta relativa al archivo de imagen desde el directorio estático, como.. image:: ejemplo.png.Con cualquiera de estos enfoques, la imagen generada se incluirá en el documento de Sphinx.