Herramienta de línea de comandos que observa archivos fuente de Go y recompila y reinicia automáticamente tu app durante el desarrollo.
24,1 mil+9 esta semana927GoGPL-3.0Actualizado hace 2 meses
sphinx-doc/sphinx-autobuild
Herramienta de línea de comandos que observa un directorio de documentación de Sphinx, la reconstruye cuando hay cambios y recarga el navegador mediante un servidor local.
- Estrellas
- 611
- Forks
- 100
- Issues abiertos
- 34
- Último commit
- hace 16 días
¿Qué es?
sphinx-autobuild observa un directorio fuente de Sphinx y ejecuta sphinx-build cada vez que cambia un archivo. Sirve el HTML generado mediante un servidor web local en http://127.0.0.1:8000 de forma predeterminada, y las ventanas abiertas del navegador se recargan automáticamente después de cada reconstrucción, para que los autores puedan ver los cambios sin tener que reconstruir ni actualizar la página manualmente.
Acepta los mismos argumentos que sphinx-build y añade opciones para el host y el puerto (el puerto 0 selecciona uno disponible), patrones de exclusión mediante glob o regex, directorios adicionales que observar, comandos previos y posteriores a la compilación, y la opción de abrir el navegador cuando el servidor esté listo. Un objetivo de Makefile puede incluirlo para ofrecer un comando «livehtml».
La herramienta resulta útil al escribir documentación o desarrollar un tema HTML de Sphinx. Para trabajar en un tema, también puede observar su directorio; además, desactivar las compilaciones incrementales con -a garantiza que todas las páginas se reconstruyan con el mismo estado del tema.
Funciones clave
- 01Reconstruye automáticamente la documentación de Sphinx cuando cambian archivos del directorio fuente.
- 02Recarga las ventanas abiertas del navegador después de cada compilación.
- 03Acepta todos los argumentos de sphinx-build y añade opciones para el servidor y la observación de archivos.
- 04Admite patrones glob y regex para excluir archivos observados.
- 05Ejecuta comandos personalizados antes y después de cada compilación.
- 06Puede seleccionar automáticamente un puerto disponible y abrir el navegador al iniciarse.
Casos de uso
- Escribir y previsualizar la documentación de un proyecto con comentarios inmediatos.
- Desarrollar un tema HTML personalizado para Sphinx mientras se observan sus archivos.
- Ejecutar varios proyectos de documentación a la vez con puertos y directorios de salida independientes.
- Enviar notificaciones al comenzar y terminar una compilación mediante hooks previos y posteriores.
Inicio rápido
- 1
Instala sphinx-autobuild desde PyPI con pip
pip install sphinx-autobuild - 2
Inicia el servidor y supervisa los cambios en el directorio docs
sphinx-autobuild docs docs/_build/html
Antes de usarlo
- Para que resulte útil, se necesita un proyecto de documentación de Sphinx.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es sphinx-autobuild?
- Herramienta de línea de comandos que observa un directorio de documentación de Sphinx, la reconstruye cuando hay cambios y recarga el navegador mediante un servidor local. sphinx-autobuild observa un directorio fuente de Sphinx y ejecuta sphinx-build cada vez que cambia un archivo. Sirve el HTML generado mediante un servidor web local en http://127.0.0.1:8000 de forma predeterminada, y las ventanas abiertas del navegador se recargan automáticamente después de cada reconstrucción, para que los autores puedan ver los cambios sin tener que reconstruir ni actualizar la página manualmente.
- ¿sphinx-autobuild es gratuito? ¿Qué licencia tiene?
- sphinx-autobuild es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿sphinx-autobuild sigue mantenido?
- Mantenimiento activo. El último commit de sphinx-autobuild fue el 23 oct 2026.
- ¿Para qué puedo usar sphinx-autobuild?
- Escribir y previsualizar la documentación de un proyecto con comentarios inmediatos. Desarrollar un tema HTML personalizado para Sphinx mientras se observan sus archivos. Ejecutar varios proyectos de documentación a la vez con puertos y directorios de salida independientes. Enviar notificaciones al comenzar y terminar una compilación mediante hooks previos y posteriores.
- ¿Cómo se instala sphinx-autobuild?
- Instala sphinx-autobuild desde PyPI con pip: pip install sphinx-autobuild Inicia el servidor y supervisa los cambios en el directorio docs: sphinx-autobuild docs docs/_build/html
- ¿Dónde consigo sphinx-autobuild?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/sphinx-doc/sphinx-autobuild
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Generador de documentación para Python que crea HTML, PDF, EPUB y otros formatos a partir de fuentes reStructuredText o Markdown.
8,1 mil2,6 milPythonOtherActualizado hace 6 días
Un plugin de Sphinx que integra en la documentación de reStructuredText y Sphinx las API de C/C++ generadas con Doxygen.
816215PythonOtherActualizado hace 6 días
Una extensión de Sphinx que incorpora las anotaciones de tipos de Python a los campos de parámetros y valores de retorno de autodoc, con enlaces y compatibilidad con stubs.
588116PythonMITBien mantenidoActualizado hace 15 horas
Una extensión de Sphinx que analiza docstrings al estilo NumPy y los convierte en documentación de API estructurada.
354184PythonOtherActualizado hace 6 días
Plataforma de código abierto que compila, versiona y aloja automáticamente documentación desde repositorios Git, con compatibilidad con Sphinx y MkDocs.
8,4 mil+1 esta semana3,7 milPythonMITBien mantenidoActualizado hace 6 horas