2013-05-17 11 views
7

Ho una directory di lavoro che contiene il mio progetto e si trova in un sistema di controllo della versione. Mi piacerebbe creare una directory doc all'interno del mio progetto che contenga solo file di testo ristrutturato per sphinx.compilazione di sphinx separata e directory di origine per il controllo della versione

Cioè, non voglio sphinx creare file html all'interno del mio progetto, ma metterli all'esterno in modo che non vengano messi nel controllo di versione.

risposta

5

Quindi, se si domanda è: 'Come posso costruire la documentazione al di fuori della struttura di origine', il documentation aiuta:

sphinx-build -b html sourcedir builddir 

Proprio punto builddir in una posizione al di fuori del vostro albero dei sorgenti.

Oppure, a seconda del sistema di controllo di versione, aggiungere la directory si genera la documentazione in un 'file di ignorare' (ad esempio .gitignore, .hgignore, ...)

+0

Stavo cercando con sfinge-quickstart - il doc ti aiuta, grazie per avermi indicato nel posto giusto. – Tim

+0

Per me, questo approccio cerca ancora index.rst nella cartella del codice sorgente ... Ho provato a specificare l'opzione 'master_doc' nel mio custom' config.py' ma non funziona. – newlog

Problemi correlati