Publish your documentation with Jupyter Book

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

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

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.

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

Try it out

.readthedocs.yaml

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

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

sphinx:
  builder: html
  configuration: docs/conf.py
  fail_on_warning: true

Publishing

Jupyter Book is an authoring tool to build beautiful, publication-quality books and documents from computational content.

Jupyter plugin

JupySQL allows you to run SQL and plot large datasets in Jupyter via a %sql, %%sql, and %sqlplot magics.

Documentation

A Sphinx and Docutils extension to parse MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.

Get your docs online in 5 minutes.

Create an account

Publish your documentation with Jupyter Book and Read the Docs

Pair-review the changes with build previews

Always find what you need

Keep your focus with link previews

Publish your book online with Read the Docs

Join thousands of happy users