Read the Docs: Documentation Simplified¶
Read the Docs simplifies software documentation by building, versioning, and hosting of your docs, automatically. This enables many “docs like code” workflows, keeping your code & documentation as close as possible.
- Never out of sync 🔄
Whenever you push code to your favorite version control system, whether that is Git or Mercurial, Read the Docs will automatically build your docs so your code and documentation are always up-to-date. Read more about VCS Integrations.
- Multiple versions 🗂️
Read the Docs can host and build multiple versions of your docs so having a 1.0 version of your docs and a 2.0 version of your docs is as easy as having a separate branch or tag in your version control system. Read more about Versioned Documentation.
- Open Source and User Focused 💓
Our code is free and open source. Our company is bootstrapped and 100% user focused. Read the Docs Community hosts documentation for over 100,000 large and small open source projects, in almost every human and computer language. Read the Docs for Business supports hundreds of organizations with product and internal documentation.
You can find out more about our all the Main Features in these pages.
Are you new to software documentation or are you looking to use your existing docs with Read the Docs? Learn about documentation authoring tools such as Sphinx and MkDocs to help you create fantastic documentation for your project.
Tutorial: Read the Docs tutorial
Importing your existing documentation: Import guide
Read the Docs feature overview¶
Learn more about configuring your automated documentation builds and some of the core features of Read the Docs.
Overview of core features: Main Features | VCS Integrations | Custom Domains | Versioned Documentation | Downloadable Documentation | Documentation Hosting Features | Server Side Search | Traffic Analytics | Preview Documentation from Pull Requests | Build Notifications and Webhooks | User-defined Redirects | Security Log
Connecting with GitHub, BitBucket, or GitLab: Connecting your VCS account
These guides will help walk you through specific use cases related to Read the Docs itself, documentation tools like Sphinx and MkDocs and how to write successful documentation.
For documentation authors: Cross-referencing with Sphinx | Link to Other Projects’ Documentation With Intersphinx | How to use Jupyter notebooks in Sphinx | More guides for authors
For project administrators: Technical Documentation Search Engine Optimization (SEO) Guide | Manage Translations for Sphinx projects | Using advanced search features | Using Private Git Submodules | More guides for administrators
Advanced features of Read the Docs¶
Read the Docs offers many advanced features and options. Learn more about these integrations and how you can get the most out of your documentation and Read the Docs.
Multi-language documentation: Translations and localization
Redirects: Automatic redirects
Versions Automation rules
Topic specific guides: How-to guides
Extending Read the Docs: REST API
Read the Docs for Business¶
Read the Docs has a commercial offering with improved support and additional features.
The Read the Docs project and organization¶
Learn about Read the Docs, the project and the company, and find out how you can get involved and contribute to the development and success of Read the Docs and the larger software documentation ecosystem.