Автоматически создавать документацию Sphinx при изменении исходного файла

Я использую Sphinx для документирования одного из моих проектов, и мне нравится просматривать мои изменения в моем браузере. Я хочу сохранить некоторые изменения в файле .rst и сразу обновить браузер и увидеть изменения.

По сути, я хочу автоматически выполнять make html всякий раз, когда .rst один из файлов .rst .

4 Solutions collect form web for “Автоматически создавать документацию Sphinx при изменении исходного файла”

Вы можете использовать sphinx-autobuild .

Он прост в использовании, например:

 sphinx-autobuild docs docs/_build/html 

или, если у вас есть отдельный строковый каталог,

 sphinx-autobuild source build/html 

Он также автоматически инициирует обновление страницы в браузере.

Якоб Каплан-Мосс имеет хорошее решение :

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

Обратите внимание, измените шаблон, чтобы он соответствовал вашему суффиксу. Jacob использует * .txt, но мне нужно было изменить его на * .rst.

Если вы находитесь в системе * nix, вы можете использовать inotify для мониторинга событий файловой системы и запуска действий.

Например, на ubuntu,

 apt-get install inotify-tools 

Затем запустите сценарий, подобный этому, для прослушивания событий в данном каталоге

 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 

Вы можете создать макрос в своем любимом редакторе, который сохранит файл и откроет его в вашем браузере, любой текстовый редактор может сделать (geany, gedit, emacs, vi, notepad ++ …)

  • Пользовательские директивы в Sphinx
  • локальная документация django
  • Сделать значения autodoc sphinx по умолчанию в описании параметров
  • Как создать документацию sphinx для проекта django
  • Включение docstring в документацию Sphinx
  • Создание большой таблицы сначала с вложенными заголовками столбцов и получение рендеринга латекса для обертывания текста заголовка
  • Как я могу сделать чтение наследования sphinx'diagram доступным?
  • Как добавить пользовательский файл css в Sphinx?
  •  
    Interesting Posts for Van-Lav

    Построение большого количества точек с использованием matplotlib и исчерпание памяти

    python subprocess set shell var. а затем запустить команду – как?

    Показать последовательные изображения / массивы с imshow как повторяющиеся анимации в python

    Каков правильный синтаксис, чтобы следовать ссылке, используя beautifulsoup & запросы в приложении django?

    Производительность создания нового DataFrame

    Исключить поля в Django admin для пользователей, отличных от суперпользователя

    Django 1.3 в appengine

    Целочисленное деление в Python

    Python, механизация, правильный синтаксис для установки нескольких заголовков?

    Определение аргумента по умолчанию в качестве глобальной переменной

    PIL Получить палитру изображений

    Поддерживает ли Python регулярные выражения для свободного пробела?

    Как счистить динамический словарь python определенных ключей?

    python lxml на движке приложения?

    Как исправить «объект JSONDecodeError: No JSON может быть расшифрован: строка 1 столбец 0 (char 0)»?

    Python - лучший язык программирования в мире.