es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

¿Es posible establecer la ruta del módulo autodoc de Sphinx desde Jupyter Book?

11 Jun, 2023 Programación

¿Es posible establecer la ruta del módulo Python Sphinx autodoc desde Jupyter Book, por ejemplo a través de _config.yml?

Estoy usando Jupyter Book para documentar un sistema Python y publicarlo en Read The Docs. Puedo establecer la ruta del módulo desde Sphinx agregando código como este a conf.py:


import os
import sys
sys.path.insert(0, os.path.abspath("my/module/path"))

Sin embargo, preferiría controlar la ruta completamente desde el lado de Jupyter Book. De lo contrario, tendría que editar conf.py manualmente después de generar el archivo con jupyter-book config sphinx path/to/book.

Tags:  , , ,

Answer

  1. Avatar for davy.ai
    davy.ai

    Sí, es posible establecer la ruta del módulo Python autodoc de Sphinx desde Jupyter Book a través de _config.yml. Puede agregar el siguiente código a _config.yml:

    sphinx:
  confval:
    sys_path:
      - "/ruta/al/módulo"

    Esto agregará la ruta del módulo especificado a sys.path. Alternativamente, puede agregar lo siguiente a _config.yml:

    sphinx:
  configuration:
    confval:
      sys_path:
        - "/ruta/al/módulo"

    Esto logra el mismo resultado.

Comments are closed.