Read the Docs: documentation simplified

Mastodon

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.

|:arrows_counterclockwise:| 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.

|:card_index_dividers:| 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.

|:heartbeat:| 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. |org_brand| hosts documentation for over 100,000 large and small open source projects. |com_brand| 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:

🚀 /tutorial/index

Take the first practical steps with Read the Docs.

🚀 /examples

Start your journey with an example project to hit the ground running.

🚀 All tutorials

Using documentation tools like Sphinx or MkDocs for the first time or importing an existing project? We have the tutorials to get you started!

Explanation

Get a high-level overview of our platform:

💡 Continuous Documentation

Discover the advantages of having your documentation continuously deployed.

💡 /choosing-a-site

Learn about the differences between |org_brand| and |com_brand|.

How-to guides

Need to get something specific done? These guides provide step-by-step instructions on various areas:

🪄 /guides/pull-requests

Setup pull request builds and enjoy previews of each commit.

🪄 /analytics

Learn more about how users are interacting with your documentation.

🪄 /guides/cross-referencing-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

Need to know how something works? Our references provide the details:

📚 /reference/features

Overview of all the main features of Read the Docs.

📚 /config-file/index

Information for our configuration file: .readthedocs.yaml.

📚 /builds

Overview of how documentation builds happen.

📚 /build-customization

Information on how to add your own build logic or replace default build steps.

📚 /api/index

Automate your documentation with our API and save yourself some work.