Quali file devo dire al mio VCS di ignorare quando si utilizza Sphinx per la documentazione?

Question

Voglio iniziare a utilizzare Sphinx per documentare il mio progetto. Ho detto a Sphinx di usare fonti separate e creare directory durante lo sphinx-quickstart. Ora il mio layout della directory è la seguente:

MyProject/ 
    myproject/ 
     __init__.py 
     mymodule.py 
    docs/ 
     source/ 
      .static/ 
      .templates/ 
      conf.py 
      index.rst 
     build/ 
     Makefile 

quali file devono essere esclusi da un repository VCS per un progetto Sphinx (vale a dire, dal momento che io uso Git, che cosa devo aggiungere al mio file .gitignore)? Ad esempio, dovrei ignorare la directory docs/build/ in modo che le modifiche alle pagine HTML generate da Sphinx non vengano tracciate?

Answer 1

Se si dà un'occhiata al contenuto del Makefile vedrai qualcosa come segue:

BUILDDIR  = build 

... 

clean: 
    -rm -rf $(BUILDDIR)/* 

Ciò significa che make clean rimuove solo la directory build in modo, per quanto riguarda il controllo di versione, ignorando il contenuto di la directory build dovrebbe essere sufficiente come sospettava già.

Answer 2

Se crei un nuovo progetto su GitHub, offrirà per te un file .gitignore con aroma Python. Questo file include one reference ai file Sphinx-generati:

# Sphinx documentation 
docs/_build/ 

Nota: Questo presuppone che si accettano i valori di default quando si esegue sphinx-quickstart. Potrebbe essere necessario regolarlo a seconda di come avete risposto a queste domande: percorso

1. Root:

   Enter the root path for documentation. 
   > Root path for the documentation [.]: 
   

   Questo determina il percorso in cui è memorizzato documentazione. Se hai creato qualcosa di diverso da docs, dovrai aggiornare di conseguenza .gitignore.

2. directory di compilazione:

   You have two options for placing the build directory for Sphinx output. 
   Either, you use a directory "_build" within the root path, or you separate 
   "source" and "build" directories within the root path. 
   > Separate source and build directories (y/n) [n]: 
   

   Se avete risposto n (default), allora Sfinge creerà la directory di compilazione a <root>/_build (i file di origine saranno memorizzati direttamente sotto <root>/).

   Se avete risposto y, quindi Sfinge creerà la directory di compilazione a <root>/build (i file di origine verranno memorizzati in <root>/source).

   Annotare la presenza/assenza del trattino di sottolineatura principale; assicurati che lo schema corrispondente nelle tue .gitignore corrispondenze.