Repolode
Submit
readthedocs

readthedocs/readthedocs.org

Open-source platform that automatically builds, versions and hosts documentation from Git repositories, supporting Sphinx and MkDocs.

View on GitHubWebsite
Stars
8,406
Forks
3,717
Open issues
383
Last commit
2 days ago

What is it?

Read the Docs hosts documentation for open source projects and teams. It pulls documentation from Git repositories, builds it with tools such as Sphinx (reStructuredText) or MkDocs (Markdown), and publishes the result on a hosted site.

It is designed around the "Docs as Code" workflow: each push to the repository can trigger a rebuild, so the published docs stay in sync with the code. Multiple versions of a project's documentation can be maintained and served alongside each other.

This repository contains the source code that powers the readthedocs.org service itself. It is a Python project, and the README points to separate documentation for setting up and managing projects and for contributing to the codebase.

Key features

  • 01Pulls documentation sources directly from Git repositories.
  • 02Builds Sphinx and MkDocs projects automatically on each push.
  • 03Maintains and serves multiple versions of documentation.
  • 04Hosts the built documentation as a public or private site.

Use cases

  • Hosting public API or library documentation for an open source project.
  • Publishing internal team documentation that updates with each commit.
  • Serving versioned docs so users can read the release matching their install.

Quick start

  1. 1

    Sign up on Read the Docs with your GitHub account

  2. 2

    Grant access to your repositories when GitHub prompts you

  3. 3

    Log in, click "Add project", select your repository and click "Continue"

  4. 4

    Review project details, click "Next", and push commits to auto-update your docs

Things to know

  • The hosted service is designed for documentation projects, and self-hosting the full platform is a substantial effort.
  • The codebase is a large Django application with many dependencies, so local development setup is involved.

In collections

Static site generators & documentation tools

Topics

#documentation#sphinx#mkdocs#python#docs-as-code#hosting#docs#sphinx-doc

FAQ

What is readthedocs.org?
Open-source platform that automatically builds, versions and hosts documentation from Git repositories, supporting Sphinx and MkDocs. Read the Docs hosts documentation for open source projects and teams. It pulls documentation from Git repositories, builds it with tools such as Sphinx (reStructuredText) or MkDocs (Markdown), and publishes the result on a hosted site.
Is readthedocs.org free to use? What license does it have?
readthedocs.org is open source under the MIT license. Check the license terms before using it in commercial products.
Is readthedocs.org still maintained?
Actively maintained. The last commit to readthedocs.org was on Nov 6, 2026.
What can I use readthedocs.org for?
Hosting public API or library documentation for an open source project. Publishing internal team documentation that updates with each commit. Serving versioned docs so users can read the release matching their install.
How do I install readthedocs.org?
Sign up on Read the Docs with your GitHub account Grant access to your repositories when GitHub prompts you Log in, click "Add project", select your repository and click "Continue" Review project details, click "Next", and push commits to auto-update your docs
Where can I get readthedocs.org?
The source code and installation instructions are on GitHub: https://github.com/readthedocs/readthedocs.org

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects