About Read the Docs
Read the Docs is a hosting platform that builds and publishes documentation from a Git repository. It is aimed at developers who want their docs rebuilt automatically whenever the code changes.
What it does
You connect a Git repository, and the platform builds the documentation, publishes it and keeps several versions available. Each pull request can get a live preview with a visual comparison against the published site, so you can check rendered output before merging. Search is included, and the service works with a range of documentation tools.
Key features
- Build docs from a connected Git repository
- Get a live preview for every pull request
- Keep versioned docs built from branches or tags
- Work with Sphinx, MkDocs and Docusaurus
- Restrict readers with single sign-on on business plans
Who it's for
Read the Docs suits open source projects, especially Python libraries, and engineering teams that want documentation treated as part of the release process. Documentation writers who do not want to run their own build pipelines will find it useful too.
Pricing and good to know
The service is free for open source and community projects, according to its homepage. Private repository access, single sign-on and some other features are listed as business features. A 30-day free trial is offered for teams, so check the current plan details before you choose one.
Highlights
- Build docs automatically from a Git repository
- View a preview of docs changes in each pull request
- Publish several doc versions from branches or tags
- Use Sphinx, MkDocs or Docusaurus as the doc tool
- Clone private repositories with a connected account
