La sfinge esegue il mio codice eseguendo 'make html'?

Question

Ho ereditato un codebase piuttosto grande per il quale voglio creare la documentazione html. Dato che è scritto in Python, ho deciso di usare la sfinge perché gli utenti del codice sono abituati al design e alla funzionalità della python-documention creata con la sfinge. Ho usato il comando sphinx-apidoc per creare automaticamente i file rst. Ho importato il percorso del modulo in sys.path in modo che la sfinge possa trovare il codice.

Fin qui tutto bene. Tuttavia, quando provo a creare l'html usando il comando make html, ci sono molti traceback che appaiono e alcuni degli esempi nel codebase sembrano essere eseguiti. Quale può essere la ragione di ciò e come posso evitare che ciò accada?

Answer 1

Quando si utilizza autodoc, la Sfinge importa i moduli documentati, quindi viene eseguito tutto il codice a livello di modulo. Questo succede ogni volta che fai "make html". In questo senso, Sphinx "esegue" il tuo codice.

Potrebbe essere necessario organizzare il codice in modo un po 'diverso per far scomparire gli errori (spostare il codice a livello di modulo per le funzioni). Vedi this question per un esempio di cosa può accadere.

Questa è la mia ipotesi, ma potrebbe non essere l'intera storia. È difficile dire di più senza ulteriori informazioni.

Answer 2

def main(): 

    print('hello world') 

if __name__ == '__main__': 

    main() 

In questo modo il codice non verrà eseguito.