Read the Docs: documentation simplified

Read the Docs simplifies managing software documentation by building and hosting your docs automatically, using the Git workflow you already use for code. Treating documentation like code lets your team use tools they already know, and makes keeping your docs updated easier.

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 for free. Read the Docs for Business supports hundreds of organizations with product and internal documentation. Learn more about these differences on our pricing page.

First time here?

We have a few places for you to get started:

Read the Docs tutorial: Follow the Read the Docs tutorial.
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: Keep your builds working by making them reproducible.

Build process

Build your documentation with ease:

Build process overview: Understand 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: Give your readers multiple versions of your documentation.
Subprojects: Host multiple projects under a single domain.
Localization and Internationalization: Translate your documentation into multiple languages.
URL versioning schemes: Learn about different URL versioning schemes.
Custom domains: Brand your documentation on your own domain.

Maintaining projects

All the tools you need as your project matures:

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

Business features

Our Business hosting has everything your business needs:

Organizations: Manage permissions across multiple teams.
Single Sign-On (SSO): Stay secure with Single Sign On.
Sharing private documentation: Share your private docs easily with contractors or customers.

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 cross-references with Sphinx: Learn how to use cross-references in a Sphinx project.
All how-to guides: Browse all our how-to guides.

Reference

More detailed information about Read the Docs:

Public REST API: Integrate Read the Docs into your other workflows.
Changelog: See what’s new in Read the Docs.
About Read the Docs: Learn more about Read the Docs and our company.