sphinx-doc/sphinx-autobuild

Что это?

Ключевые возможности

• 01Автоматически пересобирает документацию Sphinx при изменении файлов в каталоге с исходниками.
• 02Перезагружает открытые окна браузера после каждой сборки.
• 03Принимает все аргументы sphinx-build и добавляет параметры сервера и отслеживания файлов.
• 04Поддерживает шаблоны исключения в формате glob и regex для отслеживаемых файлов.
• 05Запускает пользовательские команды до и после каждой сборки.
• 06Может автоматически выбрать свободный порт и открыть браузер при запуске.

Сценарии использования

• Написание и просмотр документации проекта с мгновенной обратной связью.
• Разработка собственной HTML-темы для Sphinx с отслеживанием файлов темы.
• Одновременный запуск нескольких проектов документации на отдельных портах и с разными каталогами вывода.
• Отправка уведомлений о начале и завершении сборки с помощью хуков до и после сборки.

Быстрый старт

1. 1

   Установите sphinx-autobuild из PyPI с помощью pip

   pip install sphinx-autobuild
2. 2

   Запустите сервер и отслеживайте изменения в каталоге docs

   sphinx-autobuild docs docs/_build/html

Что важно знать

• !Для полноценного использования необходим проект документации на Sphinx.

В подборках

Темы

Частые вопросы

Что такое sphinx-autobuild?

CLI-инструмент, который отслеживает каталог с документацией Sphinx, пересобирает её при изменениях и обновляет страницы в браузере через локальный сервер. sphinx-autobuild отслеживает каталог с исходниками Sphinx и запускает sphinx-build при изменении любого файла. Он раздаёт сгенерированный HTML через локальный веб-сервер, по умолчанию доступный по адресу http://127.0.0.1:8000, а открытые окна браузера автоматически перезагружаются после каждой сборки. Так авторы могут сразу видеть изменения, не запуская сборку и не обновляя страницу вручную.

sphinx-autobuild можно использовать бесплатно? Какая у него лицензия?

sphinx-autobuild распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

sphinx-autobuild всё ещё поддерживается?

Активно поддерживается. Последний коммит в sphinx-autobuild — 23 окт. 2026 г..

Для чего можно использовать sphinx-autobuild?

Написание и просмотр документации проекта с мгновенной обратной связью. Разработка собственной HTML-темы для Sphinx с отслеживанием файлов темы. Одновременный запуск нескольких проектов документации на отдельных портах и с разными каталогами вывода. Отправка уведомлений о начале и завершении сборки с помощью хуков до и после сборки.

Как установить sphinx-autobuild?

Установите sphinx-autobuild из PyPI с помощью pip: pip install sphinx-autobuild Запустите сервер и отслеживайте изменения в каталоге docs: sphinx-autobuild docs docs/_build/html

Где скачать sphinx-autobuild?

Исходный код и инструкции по установке — на GitHub: https://github.com/sphinx-doc/sphinx-autobuild