源文件更改时自动生成Sphinx文档

Question

我正在使用Sphinx记录我的一个项目,我喜欢在浏览器中预览我的更改.我希望能够保存对.rst文件的一些更改,并能够立即刷新我的浏览器并查看更改.

基本上我想在make html每当一个.rst文件被更改时自动执行.

Answer 1

你可以使用sphinx-autobuild.

它易于使用,例如:

sphinx-autobuild docs docs/_build/html

或者,如果你有一个单独的构建目录,

sphinx-autobuild source build/html

它还将自动在浏览器中启动页面刷新.

Answer 2

Jacob Kaplan-Moss 有一个很好的解决方案:

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

注意,更改模式以匹配您的后缀.Jacob使用*.txt,但我需要将其更改为*.rst.

Answer 3

您可以在您最喜欢的编辑器中创建一个宏来保存文件并在浏览器中打开它，任何文本编辑器都可以（geany、gedit、emacs、vi、notepad++...）