Read the Docs: documentation simplified

Read the Docs simplifies software documentation by building, versioning, and hosting of your docs, automatically. Treating documentation like code keeps your team in the same tools, and your documentation up to date.

Up to date documentation: Whenever you push code to Git, Read the Docs will automatically build your docs so your code and documentation are always up-to-date. Get started with our tutorial.
Documentation for every version: Read the Docs can host multiple versions of your docs. Keep your 1.0 and 2.0 documentation online, pulled directly from Git. Start hosting all your versions.
Open source and user focused: Our company is bootstrapped and 100% user-focused, so our product gets better for our users instead of our investors. Read the Docs Community hosts documentation for over 100,000 large and small open source projects. Read the Docs for Business supports hundreds of organizations with product and internal documentation. Learn more about our two platforms.

First time here?

We have a few places for you to get started:

Read the Docs tutorial: Take the first practical steps with Read the Docs.
Choosing between our two platforms: Learn about the differences between Read the Docs Community and Read the Docs for Business.
Example projects: Start your journey with an example project to hit the ground running.

Project setup and configuration

Start with the basics of setting up your project:

Configuration file overview: Learn how to configure your project with a .readthedocs.yaml file.
How to create reproducible builds: Learn how to make your builds reproducible.

Build process

Build your documentation with ease:

Build process overview: Overview of how documentation builds happen.
Pull request previews: Setup pull request builds and enjoy previews of each commit.

Hosting documentation

Learn more about our hosting features:

Versions: Host multiple versions of your documentation.
Subprojects: Host multiple projects under a single domain.
Localization and Internationalization: Host your documentation in multiple languages.
URL versioning schemes: Learn about different versioning schemes.
Custom domains: Host your documentation on your own domain.

Maintaining projects

Keep your documentation up to date:

Redirects: Redirect your old URLs to new ones.
Analytics for search and traffic: Learn more about how users are interacting with your documentation.
Security logs: Keep track of security events in your project.

Business features

Features for organizations and businesses:

Business hosting: Learn more about our commercial features.
Organizations: Learn how to manage your organization on Read the Docs.
Single Sign-On (SSO): Learn how to use single sign-on with Read the Docs.

How-to guides

Step-by-step guides for common tasks:

How to configure pull request builds: Setup pull request builds and enjoy previews of each commit.
How to use traffic analytics: Learn more about how users are interacting with your documentation.
How to use cross-references with Sphinx: Learn how to use cross-references in a Sphinx project.
All how-to guides: Browser the entire catalog for many more how-to guides.

Reference

More detailed information about Read the Docs:

Public REST API: Automate your documentation with our API and save yourself some work.
Changelog: See what’s new in Read the Docs.
About Read the Docs: Learn more about Read the Docs and our company.