Cree automáticamente la documentación de Sphinx cuando un archivo de origen cambie

Question

Estoy usando Sphinx para documentar uno de mis proyectos, y me gustaría obtener una vista previa de mis cambios en mi navegador. Deseo poder guardar algunos cambios en un archivo .rst, y poder actualizar inmediatamente mi navegador y ver los cambios.

Esencialmente quiero ejecutar automáticamente un make html cada vez que se cambia uno de los archivos .rst.

Answer 1

Puede crear una macro en que editor favorito que guarda el archivo y lo abre en su navegador, cualquier editor de texto puede hacer (Geany, gedit, emacs, vi, Notepad ++ ...)

Answer 2

Si' En un sistema * nix, puede usar inotify para monitorear eventos del sistema de archivos y desencadenar acciones.

Por ejemplo, en Ubuntu,

apt-get install inotify-tools 

A continuación, ejecute un script como este para detectar eventos en un dadas dir

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-musgo has a good solution:

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

Nota, cambie el patrón para que coincida con su sufijo. Jacob usa * .txt, pero yo necesitaba cambiarlo a * .rst.

Answer 4

Puede usar sphinx-autobuild.

Es fácil de usar, por ejemplo:

sphinx-autobuild docs docs/_build/html 

o, si usted tiene un directorio de compilación separada,

sphinx-autobuild source build/html 

También iniciará automáticamente una actualización de la página en el navegador.