Creazione automatica della documentazione Sphinx quando un file sorgente cambia

Question

Sto utilizzando Sphinx per documentare uno dei miei progetti e mi piace visualizzare l'anteprima delle modifiche nel mio browser. Voglio essere in grado di salvare alcune modifiche ad un file .rst, ed essere in grado di aggiornare immediatamente il mio browser e vedere le modifiche.

In sostanza, voglio eseguire automaticamente un make html ogni volta che uno dei file .rst viene modificato.

Answer 1

È possibile creare una macro in voi editor preferito che salva il file e lo apre nel browser, qualsiasi editor di testo può fare (geany, gedit, Emacs, VI, Notepad ++ ...)

Answer 2

Se si' su un sistema * nix, è possibile utilizzare inotify per monitorare eventi del filesystem e azioni di trigger.

Per esempio, su ubuntu,

apt-get install inotify-tools 

quindi eseguire script come questo per ascoltare gli eventi in una determinata directory

while true 
    do 
    inotifywait -r -e modify -e move -e create -e delete /tmp/docs | while read line 
     do 
     echo "file changed; time to run make html" 
     done 
    done 

Answer 3

Jacob Kaplan-Moss has a good solution:

pip install watchdog 
watchmedo shell-command \ 
      --patterns="*.rst" \ 
      --ignore-pattern='_build/*' \ 
      --recursive \ 
      --command='make html' 

Nota, modificare il modello in modo che corrisponda al suffisso. Jacob usa * .txt, ma ho dovuto cambiarlo in * .rst.

Answer 4

È possibile utilizzare sphinx-autobuild.

E 'facile da usare, per esempio:

sphinx-autobuild docs docs/_build/html 

o, se si dispone di una directory di costruzione separata,

sphinx-autobuild source build/html 

Sarà anche avviare automaticamente un aggiornamento della pagina nel browser.