¿Sphinx ejecuta mi código al ejecutar 'make html'?

Question

Heredé una base de código bastante grande para la que quiero crear documentación html. Como está escrito en Python, decidí usar sphinx porque los usuarios del código están acostumbrados al diseño y la funcionalidad de la documentación python que se creó con sphinx. Utilicé el comando sphinx-apidoc para crear automáticamente los primeros archivos. Importé la ruta del módulo en sys.path para que sphinx pueda encontrar el código.

Hasta ahora todo bien. Sin embargo, cuando intento crear el html con el comando make html, aparecen muchas trazas y algunos de los ejemplos en la base de código parecen ejecutarse. ¿Cuál puede ser el motivo y cómo puedo evitar que eso suceda?

Answer 1

Al utilizar autodoc, Sphinx importa los módulos documentados, por lo que se ejecuta todo el código de nivel de módulo. Esto sucede cada vez que haces "make html". En ese sentido, Sphinx "ejecuta" tu código.

Puede que tenga que organizar el código de una manera un poco diferente para que los errores desaparezcan (mueva el código de nivel de módulo a las funciones). Consulte this question para ver un ejemplo de lo que puede pasar.

Esta es mi suposición, pero puede que no sea toda la historia. Es difícil decir más sin información adicional.

Answer 2

def main(): 

    print('hello world') 

if __name__ == '__main__': 

    main() 

De esta manera, su código no se ejecutará.