Repolode
提交项目
readthedocs

readthedocs/readthedocs.org

开源文档平台，可从 Git 仓库自动构建、版本化并托管文档，支持 Sphinx 和 MkDocs。

在 GitHub 查看官网
Star
8,406
Fork
3,717
未关闭 Issue
383
最近提交
昨天

这是什么？

Read the Docs 为开源项目和团队托管文档。它从 Git 仓库拉取内容，使用 Sphinx（reStructuredText）或 MkDocs（Markdown）等工具构建，并将结果发布到线上站点。

它围绕“文档即代码”的工作流设计，仓库每次推送都可以触发重新构建，让线上文档与代码保持同步。同一项目的多个版本文档也可以并存维护和访问。

本仓库是 readthedocs.org 服务本身的源代码，基于 Python 编写。项目的部署配置与贡献指南另有独立文档。

核心功能

  • 01直接从 Git 仓库拉取文档源文件。
  • 02每次推送代码后自动构建 Sphinx 和 MkDocs 项目。
  • 03支持维护并同时提供多个版本的文档。
  • 04将构建结果托管为公开或私有站点。

适用场景

  • 为开源项目托管公开的 API 或库文档。
  • 发布随代码提交自动更新的团队内部文档。
  • 提供按版本划分的文档，方便用户查阅与所装版本对应的内容。

快速上手

  1. 1

    使用 GitHub 账号注册 Read the Docs

  2. 2

    在 GitHub 提示时授予对你仓库的访问权限

  3. 3

    登录后点击“Add project”，选择你的仓库并点击“Continue”

  4. 4

    检查项目信息并点击“Next”，之后每次推送提交都会自动更新文档

使用前须知

  • 该项目面向文档托管场景，自行部署完整平台需要大量工作。
  • 代码库是一个依赖众多的大型 Django 应用，本地开发环境配置较复杂。

收录于专题

静态网站生成器与文档工具

标签

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

常见问题

readthedocs.org 是什么？
开源文档平台，可从 Git 仓库自动构建、版本化并托管文档，支持 Sphinx 和 MkDocs。 Read the Docs 为开源项目和团队托管文档。它从 Git 仓库拉取内容，使用 Sphinx（reStructuredText）或 MkDocs（Markdown）等工具构建，并将结果发布到线上站点。
readthedocs.org 可以免费使用吗？用的什么许可证？
readthedocs.org 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
readthedocs.org 还在维护吗？
活跃维护中。readthedocs.org 最近一次提交是在 2026年11月6日。
readthedocs.org 适合用来做什么？
为开源项目托管公开的 API 或库文档。 发布随代码提交自动更新的团队内部文档。 提供按版本划分的文档，方便用户查阅与所装版本对应的内容。
readthedocs.org 怎么安装和运行？
使用 GitHub 账号注册 Read the Docs 在 GitHub 提示时授予对你仓库的访问权限 登录后点击“Add project”，选择你的仓库并点击“Continue” 检查项目信息并点击“Next”，之后每次推送提交都会自动更新文档
在哪里获取 readthedocs.org？
源代码和安装说明在 GitHub 上：https://github.com/readthedocs/readthedocs.org

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目