Ratings aggregated from independent review platforms. Learn more
Key Features
Automatic deploy previews for pull requestsSupports Sphinx, MkDocs, Jupyter Book, and other documentation toolsIntegrated search across all documentationVersioned documentation from any branch or tagPrivate repository support (paid plans)Single Sign-On (SSO) with GitHub, GitLab, and Google (paid plans)Team management and permissionsCustom domains
Read the Docs is a comprehensive platform for deploying and managing documentation, designed to integrate seamlessly with Git workflows. It enables teams to adopt a "Docs as Code" approach, allowing developers and writers to create and maintain documentation using familiar tools like Git and text editors. The platform supports popular documentation tools such as Sphinx, MkDocs, and Jupyter Book.
It caters to both open-source projects and businesses, offering features like automatic deploy previews for pull requests, versioned documentation to match product release cycles, and integrated search capabilities. For businesses, it provides advanced features such as private repository support, Single Sign-On (SSO), team management, and detailed analytics. The platform aims to streamline the documentation process, ensuring accuracy, collaboration, and efficient delivery of technical content.
Read the Docs is ideal for software development teams, technical writers, and open-source projects that need a robust, scalable, and automated solution for hosting and publishing their documentation. It simplifies the publishing pipeline, allowing users to focus on content creation while the platform handles building, hosting, and versioning.
What specific documentation tools are natively integrated with Read the Docs?
Read the Docs offers integrated support for Sphinx, MkDocs, and Jupyter Book. Its flexible architecture also allows it to work with any other documentation tool.
How does Read the Docs facilitate collaboration and review of documentation changes?
It provides automatic deploy previews for every pull request, allowing teams to review documentation changes before they are merged. This ensures that everyone can see what's being shipped and collaborate effectively.
Can I host documentation for private repositories, and what are the requirements for doing so?
Yes, private repository support is a feature of paid plans. You can clone private repositories by connecting your GitHub, GitLab, or Bitbucket account, or by using an SSH key for other Git providers.
What are the differences in Single Sign-On (SSO) options across the various paid plans?
The Advanced plan supports SSO with GitHub and GitLab. The Pro plan extends this to include Google for SSO. Enterprise plans can be customized for specific SSO requirements, including SAML.
How does Read the Docs handle versioning of documentation to align with product release cycles?
Read the Docs allows you to match your product release cycle by supporting multiple versions of your documentation. It can automatically build these versions directly from any branch or tag in your Git repository.
What are the retention periods for search and pageview analytics on the different business plans?
The Advanced plan retains search and pageview analytics for 30 days. The Pro plan extends this retention period to 90 days for both search and pageview analytics.