Support ReadTheDocs

It would be great if Jupyter Books could be built on ReadTheDocs. This would allow people to easily host their book content online, and would also benefit from other features in the readthedocs ecosystem.

As RTD builds Sphinx natively, this shouldn’t be too difficult. But we might run into some snags somewhere. I remember another issue having some discussion of this but I cannot find it, so I’m opening this “meta” issue to be more easily-findable, and we can link out to specific issues from here.

cc RTD folks @ericholscher @humitos @stsewd

and @chrisjsewell who mentioned that he wanted to see this happen soon!

ToDo

• Ensure that Jupyter Book builds with the various configuration options that are available in RTD (e.g. PDF, epub, etc)
• Make sure there are no edge-cases that make it unstable for RTD
• Get RTD to support the build command of Jupyter Book (jupyter-book build ./mybook)
• Document this integration
• Write a blog post! (maybe showing off some nifty RTD-specific stuff like sphinx-hoverxref?)

PRs

• https://github.com/executablebooks/jupyter-book/issues/985

[choldgraf]

I took a quick pass and made some minor edits, it looks good to me! thanks 😃

[astrojuanlu]

Hi folks! I just tried this out and it works beautifully, even though it was my first time configuring pre-commit on a repository for real. The result lives here:

https://jb-on-rtd.readthedocs.io/ (sources https://github.com/astrojuanlu/jupyterbook-on-read-the-docs)

any chance you’d be interested in co-writing a short blog post about this?

Sure thing! Will share a draft later today or tomorrow 🚀