Read the Docs

Read the Docs

Read the Docs is a web service for hosting documentation online. They offer free web hosting for open source projects, sustained by ethical advertising that is inserted into pages. These ads can also be removed with a small monthly payment to help sustain the project.

Read the Docs builds Sphinx websites, and does not support Jupyter Book directly. However, you can convert your book to a Sphinx website in order to publish with Read the Docs.

To publish your book with Read the Docs, follow these steps:

  1. Get started with Read the Docs. To do so, follow the Read the Docs tutorial. Configure Read the Docs to host a website from your book’s repository.

  2. Convert your book into a Sphinx site. There are two ways to do this using the Jupyter Book CLI.

    In either case, it will generate a conf.py file along with your book’s source files. This is the file Sphinx uses to build your book.

  3. Commit the conf.py file and push to your online repository.

If you’ve configured Read the Docs correctly, it should now automatically build your book’s HTML and host it online.