Full featured documentation deployment platform

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

A terminal executing Git commands to build multiple versions of documentation

Preview changes on every commit to your pull requests. Release documentation to your users on each merge.

Write documentation without changing your workflow or your tools using a docs as code approach.

Easily share within your team or with the whole world. Manage permissions yourself or automatically with GitHub.

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

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

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

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

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

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

Discover all our features

Try it out

.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