jupyter-book watch command

Description / Summary

It would be nice if jupyter books automatically rebuilt upon changing a file, and fresh files were served over a development server.

Value / benefit

You need to keep several windows open to develop a jupyterbook - vscode, a terminal, a browser window, maybe the inspector. On a laptop, it’s a lot of windows to keep around. It would be nice not to have to look at one of those windows. It would be nice to always be one Ctrl+R away from seeing the latest build of the docs.

Implementation details

The sphinx book theme has support for live building using the tox -e docs-live command. I presume this would be substantially similar to this.

Tasks to complete

No response

[chrisjsewell]

Heya, a couple of things to note here:

1. there has been a previous discussion about this: https://github.com/executablebooks/jupyter-book/issues/213 (not really sure why it was closed)
2. It was certainly in my thinking to do this with sphinx-autobuild: https://github.com/executablebooks/sphinx-autobuild/issues/87
3. jupyter-book now has the ability for external packages to “inject” commands in to the CLI, this is for example how jupyter-book toc works (https://github.com/executablebooks/sphinx-external-toc/blob/ec4a43904dde7e24b3d08bd2c717c696ef20aff9/setup.cfg#L43-L44). By the same mechanism, an external package (like sphinx-autobuild) could inject a jupyter-book serve command (see also https://github.com/executablebooks/sphinx-autobuild/issues/99)

[patrickmineault]

I saw that this is now feasible with sphinx-autobuild:

jupyter-book config sphinx .
sphinx-autobuild . _build/html -b html

There’s a hint about this in the Sphinx section of the docs, but if it’s relevant I can draft a larger section on setting this up in the docs.