Full featured documentation deployment platform - Read the Docs

Documentation simplified

Build, host, and share documentation, all with a single platform.

Sign up now
A terminal executing Git commands to build multiple versions of documentation

Automatic deploy previews

Preview your documentation on every pull request. Never guess what you're shipping again.

Ideal developer experience

Write documentation with Git and your favorite text editor. Developers and writers both love docs as code.

Work privately or publicly

Share content with just your team, or with the whole world. Sync permissions from GitHub, or manage custom permissions for your projects.

Features

Supports any doc tool

Integrated support for Sphinx, MkDocs, Jupyter Book. Flexible enough to work with any documentation tool.

Integrated search

Easily search all your docs via our dashboard, and offer your users a more powerful search with our search API.

Pull request previews

Preview each pull request before releasing any changes, allowing for fast collaboration across your organization.

Versioned docs

Match your product release cycle with multiple versions of your docs. Automatically build versions from any branch or tag.

Private repository support Paid plan feature

Clone private repositories using a connected GitHub, GitLab, or Bitbucket account, or clone from any Git provider with an SSH key.

Single-Sign On Paid plan feature

Control who has access to your documentation with integrated authentication. Enable SSO with GitHub or GitLab to easily manage permissions in one place.

Try it out

Upgrade your documentation with Read the Docs

.readthedocs.yaml
version: 2
build:
  os: ubuntu-22.04
  tools:
    python: "3.10"
    # You can also specify other tool versions:
    # nodejs: "16"

# Build documentation in the docs/ directory with Sphinx
sphinx:
   configuration: docs/conf.py

# Dependencies required to build your docs
python:
   install:
   - requirements: docs/requirements.txt
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