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 Continuous Documentation Deployment.
- 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 features in these pages.
First stepsο
Are you new to software documentation? 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
Getting started: With Sphinx | With MkDocs | Choosing between our two platforms
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: Custom domains | Versioned documentation | Understanding offline formats | Server side search | How to use traffic analytics | Preview documentation from pull requests | Build Notifications and Webhooks | Custom and built-in redirects on Read the Docs | Security logs
Connecting with GitHub, Bitbucket, or GitLab: Connecting your VCS account
Read the Docs build process: Configuration reference | Build process | Build customization | Understanding environment variables | Environment variables | Status badges
Troubleshooting: Site support | Frequently asked questions
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.
Advanced project configuration: Subprojects: host multiple projects on a single domain | Single version docs | Flyout menu | Feature flags
Multi-language documentation: Translations and localization
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.
Read the Docs for Business: Organizations | Single sign on | Project privacy level | Sharing externally
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.
Policies & Process: Security reports | DMCA takedown policy | Abandoned projects policy | Unofficial and unmaintained projects policy | Release notes & changelog
The people and philosophy behind Read the Docs: About us | Team | Open source philosophy | Our story
Financial and material support: Advertising | Sponsors
Legal documents: Terms of service | Privacy policy | Data processing agreement
Getting involved with Read the Docs: Glossary | Developer documentation