Jupyter Book logo

Publish your documentation with Jupyter Book and Read the Docs

Jupyter Book works perfectly with Read the Docs, allowing your book to be published online and always updated with the latest version.

Create an account See a demo

Pair-review the changes with build previews

Receive feedback from your team, and have confidence in changes before they go live.

Always find what you need

Search across all your books and projects with our search-as-you-type interface, and quickly find the paragraph, documentation and API reference information you need. Never lose documentation again.

Keep your focus with link previews

Provide context on every internal link in your docs with instant preview links. Skim the content without opening another tab.

Try it out

Publish your book online with Read the Docs

version: 2
  os: ubuntu-22.04
    python: "3.11"
      # Generate the Sphinx configuration for
      # this Jupyter Book so it builds.
      - "jupyter-book config sphinx docs/"

# Dependencies required to build your docs
     - method: pip
       path: .
         - sphinx

  builder: html
  configuration: docs/conf.py
  fail_on_warning: true
Create an account Sign up with GitHub or your email. Import your project Select your existing Git repositories with a 1-click interface. Add YAML config Copy this example, it probably does what you want 😉 Your docs build on every commit Like magic.

Get your docs online in 5 minutes.

Create an account