Open edX edx-platform 开发者文档体系导读从文档门户到源码级实践指南【免费下载链接】openedx-platformThe Open edX LMS Studio, powering education sites around the world!项目地址: https://gitcode.com/GitHub_Trending/ed/openedx-platformedx-platformOpen edX 的 LMS 与 Studio 核心仓库在 docs/ 目录下维护了一套自包含的开发者文档体系而 docs/index.rst 正是这套体系的总门户它定义了文档板块的划分、构建入口、外部文档资源引用与版本变更脉络。本文将以此门户为骨架逐一展开每个板块指向的真实技术内容——从 Celery 任务队列路由的实战规范到 REST API 的 JWT 认证调用、Feature Toggle 与 Settings 参考、架构决策记录ADR的演进历史——并结合仓库源码如 lms/envs/production.py与 Sphinx 构建配置帮助你快速定位任意模块的开发文档理解文档背后对应的实现机制。文档门户的定位与总体结构docs/index.rst是 Sphinx 文档树的根页面master_doc承担三类职责划分文档板块通过两个toctree指令将全部文档组织为「可见目录」与「隐藏目录」两级结构提供主题化导航使用sphinx_design扩展的grid/grid-item-card指令将文档按 How-tos、References、Concepts、Hooks and Extensions、App Documentation 五个主题呈现为卡片式入口记录变更历史在页面底部以 Change History 章节追溯文档体系自 2014 年以来的演进。从目录树可以看出门户共收纳了以下文档目录均为仓库根下的真实路径板块文档目录典型主题How-tos操作指南docs/how-tos/Celery 任务编写、REST API 调用References参考手册docs/references/LMS API 清单、Settings、Feature Toggles、认证代码示例Concepts概念指南docs/concepts/扩展点、测试策略、前端开发、REST API 设计Hooks and Extensionsdocs/extensions/TinyMCE 插件等扩展机制App Documentationdocs/decisions/架构决策记录ADR与各应用文档其中「可见目录」:maxdepth: 1的 toctree只列出 docstrings 索引其余板块通过:hidden:属性的 toctree 收录再以卡片形式在前端展示——这是 Sphinx 文档门户的典型组织方式。文档构建系统Sphinx 配置与构建命令文档门户本身只是一份.rst源文件真正让它变成可浏览 HTML 的是配套的构建配置。仓库根下的 docs/conf.py 是 Sphinx 构建器的核心配置文件其中有几个值得注意的工程细节复用 Django 环境构建时通过sys.path.insert(0, root)将仓库根目录加入PYTHONPATH并默认设置DJANGO_SETTINGS_MODULE docs.docs_settings见 docs/docs_settings.py随后调用django.setup()。这使得文档可以直接导入 LMS 与 Studio 的全部代码支撑sphinx-apidoc自动生成 docstring 文档。动态生成参考内容extensions列表中启用了code_annotations.contrib.sphinx.extensions.featuretoggles与...settings两个扩展见 docs/conf.py它们负责在构建时扫描源码中的feature_toggle与settings注解自动生成 docs/references/featuretoggles.rst 与 docs/references/settings.rst 中的完整清单——这正是这两份参考手册能保持与代码同步的原因。API 文档嵌入通过sphinxcontrib.openapi扩展与.. openapi::指令将 docs/lms-openapi.yamlOpenAPI 规范文件直接渲染为 LMS API 文档。重定向管理使用rediraffe与sphinx_reredirects扩展维护文档迁移后的链接docs/redirects.txt 记录了所有历史路径到新路径的映射。构建入口定义在 docs/Makefile使用标准sphinx-build默认开启-j auto并行编译产物输出到_build/目录。常用命令# 在 docs/ 目录下执行 make html # 生成 HTML 文档 make clean # 清理构建产物含自动生成的 cms/common/lms/openedx 目录 make update_redirects # 生成因文件移动而缺失的重定向记录 make check_redirects # 校验所有移动过的文件是否都有重定向How-tos面向实战的操作指南docs/index.rst的「How-tos」卡片指向 docs/how-tos/index.rst以:glob:递归收录该目录下全部文档当前包含两份核心指南docs/how-tos/celery.rst如何编写 Celery 任务与 docs/how-tos/use_the_api.rst如何使用 REST API。编写 Celery 任务的队列路由规范docs/how-tos/celery.rst 记录了一次重要的技术演进随着 Celery 升级到 4.4旧版基于类的自定义路由器失效edx-platform 因此迁移到新的 Task Router API改用函数式路由 显式队列字典的方案。该文档确立了两条关键规范不再使用task装饰器中的routing_key参数Celery 新版本中该参数已不再把任务路由到对应 key 的队列继续使用会产生误导。通过EXPLICIT_QUEUES字典声明任务队列在 LMS 与 CMS 的 Django settings 中各维护一份EXPLICIT_QUEUES需要将任务路由到非默认队列时按以下模式登记文档原文示例lms.djangoapps.grades.tasks.compute_all_grades_for_course: { queue: POLICY_CHANGE_GRADES_ROUTING_KEY},该文档特别强调了一个易踩坑的注意点任务加入 LMS 的EXPLICIT_QUEUES后只有从 LMS 环境触发才会被路由到指定队列若需要从 CMS 环境也触发该任务则必须在 CMS 的EXPLICIT_QUEUES中重复登记。这条规范在源码中得到了完整印证在 lms/envs/production.py 的######## CELERY ROUTING ########配置段中可以看到真实生效的EXPLICIT_QUEUES定义例如EXPLICIT_QUEUES { openedx.core.djangoapps.content.course_overviews.tasks.async_course_overview_update: { queue: GRADES_DOWNLOAD_ROUTING_KEY}, lms.djangoapps.bulk_email.tasks.send_course_email: { queue: BULK_EMAIL_ROUTING_KEY}, lms.djangoapps.grades.tasks.recalculate_course_and_subsection_grades_for_user: { queue: POLICY_CHANGE_GRADES_ROUTING_KEY}, lms.djangoapps.grades.tasks.recalculate_subsection_grade_v3: { queue: SINGLE_LEARNER_COURSE_REGRADE_ROUTING_KEY}, ... }从源码结构看文档示例中的compute_all_grades_for_course任务在后来的演进中已被拆分/重命名为recalculate_course_and_subsection_grades_for_user等更细粒度的任务但任务名 → 队列名的字典登记模式始终保持不变。各路由 key 在 lms/envs/mock.yml 中也有定义如POLICY_CHANGE_GRADES_ROUTING_KEY: edx.lms.core.default说明该机制贯穿 mock、production 等多套环境配置。使用 REST APIOAuth2 客户端凭据 JWT 认证docs/how-tos/use_the_api.rst 是一份完整的端到端实操指南解决如何向 edx-platform REST API 发起认证请求这一核心问题。它的前置假设包括能访问 edx-platform 的 Django Admin/admin、准备一个用于发起请求的用户UserA、以及 LMS 运行在https://lms.example.com。完整步骤如下原文全部保留打开https://lms.example.com/admin/oauth2_provider/application/点击Add Application为用户 UserA 创建应用客户端类型选择Confidential机密型授权类型选择Client Credentials客户端凭据为应用命名保存后记录下client_id与client_secret用这两个凭证换取 JWT 访问令牌。文档给出了可直接运行的 Python 换取 JWT 的代码import base64 import requests client_id vovj0AItd9EnrOKjkDli0HpSF9HoooaTY9yueafn # Client secrets should not be exposed in your code, we put it here to # make the example more clear. client_secret a3Fkwr24dfDSlIXt3v3q4Ob41CYQNZyGmtK8Y8ax0srpIa2vJON3OC5Rvj1i1wizsIUv1W1qM1Q2XPeuyjucNixsHXZsuw1dn2B9nH3IyjSvuFb5KoydDvWX8Hx8znqD credential f{client_id}:{client_secret} encoded_credential base64.b64encode(credential.encode(utf-8)).decode(utf-8) headers {Authorization: fBasic {encoded_credential}, Cache-Control: no-cache} data {grant_type: client_credentials, token_type: jwt} token_request requests.post( http://lms.example.com/oauth2/access_token, headersheaders, datadata ) access_token token_request.json()[access_token]得到 JWT 后即可携带Authorization: JWT access_token请求头调用任意 API 端点文档以获取 UserA 的全部选课为例enrollment_request requests.get( http://lms.example.com/api/enrollment/v1/enrollment, headers{Authorization: fJWT {access_token}}, )该流程对应的后端实现位于common/djangoapps/third_party_auth与openedx/core/djangoapps/oauth_dispatch等模块OAuth2 token 端点即oauth2/access_token认证方式可进一步参考 docs/references/auth_code_samples.rst。References与代码实时同步的参考手册「References」板块由 docs/references/index.rst 组织内容分三类API 参考docs/references/lms_apis.rst 通过.. openapi:: ../lms-openapi.yaml指令直接渲染 docs/lms-openapi.yaml 中定义的 LMS API 端点清单文档还提示先阅读 docs/how-tos/use_the_api.rst 学习认证方式两者形成认证教程 端点清单的闭环。自动生成的配置清单docs/references/featuretoggles.rst 与 docs/references/settings.rst 分别列出所有 Open edX Feature Toggle 与 Django 设置项由code_annotations的 Sphinx 扩展在构建时从源码注解自动生成用于在生产环境手动启用/禁用功能。这类 Toggle 在源码中对应openedx/core/toggles.py的WaffleFlag/WaffleSwitch体系。docstring 索引docs/references/docstrings/ 下按 CMS、LMS、common 分层组织模块级 docstring 文档如 docs/references/docstrings/lms_index.rst依赖 docs/conf.py 中对仓库根的sys.path配置实现跨模块导入。Concepts理解平台设计的关键概念「Concepts and Guides」板块docs/concepts/index.rst是理解 edx-platform 设计哲学的入口当前收录docs/concepts/extension_points.rst扩展点概念说明如何在不动核心代码的前提下扩展平台docs/concepts/testing/testing.rst测试策略与测试金字塔模型docs/concepts/frontend/ 下的javascript.rst、styling.rst、bootstrap.rst前端开发规范docs/concepts/rest_apis.rstREST API 设计约定是 docs/how-tos/use_the_api.rst 的 seealso 关联文档。docs/index.rst的卡片中还列出了 docs/concepts/testing/testing.rst 与 docs/concepts/frontend/javascript.rst 作为 Concepts 板块的代表条目。Hooks and Extensions扩展机制专题「Hooks and Extensions」卡片聚焦平台的可扩展能力TinyMCE 插件docs/extensions/tinymce_plugins.rst 介绍富文本编辑器的自定义插件机制对应的实现主要位于 CMS 与xmodule的静态资源中Hooks 扩展框架门户通过外部链接指向 docs.openedx.org 的 Hooks Extensions Framework 文档说明该主题的权威说明已随文档体系外迁但仓库内 docs/concepts/extension_points.rst 仍然保留着本地的扩展点概念说明。App Documentation架构决策记录与演进史「App Documentation」卡片指向 docs/decisions/index.rst收录了 edx-platform 全部架构决策记录ADR——这是文档体系中最有历史价值的部分。截至当前仓库docs/decisions/ 下共有 40 余条按编号排列的决策记录如0000-static-asset-plan.rst、0006-role-of-xblock.rst、0013-cms-vs-studio.rst、0022-settings-simplification.rst、0037-api-versioning-strategy.rst、0038-standardize-rest-api-url-structure.rst等覆盖静态资源方案、XBlock 定位、CMS 与 Studio 的关系、设置简化、API 版本化策略等关键架构话题。这些 ADR 对理解当前代码为什么长这样极有价值。变更历史文档体系的演进脉络docs/index.rst底部的 Change History 完整记录了文档组织方式的演变April 2025文档迁移至 docs.openedx.org因此门户中大量出现指向外部文档空间的说明Jun 30, 2023新增 API、Feature Toggle 与 Settings 文档并重新组织文档布局本次重组形成了如今的 How-tos / References / Concepts 分类December 2020新增关于 Celery 任务编写新协议的文档即EXPLICIT_QUEUES路由规范April 2019恢复 API 与仓库级文档构建May 2017清空本地 docs 目录、从零重建当前文档体系的上一次大规模重构起点January 13, 2015 / November 3, 2014开发者指南与若干子项目文档迁入独立的 edx-documentation 仓库。这段历史解释了当前仓库文档的形态本地 docs/ 保持精简的开发者文档而面向用户与一般开发者的大部头指南托管在独立文档站点同时通过 docs/redirects.txt 与 Makefile 中的update_redirects/check_redirects目标保证历史链接不失效。如何基于门户快速定位所需文档在 edx-platform 中按需查阅文档可遵循以下路径想调用某个 REST API先读 docs/how-tos/use_the_api.rst 完成认证配置再对照 docs/references/lms_apis.rst 渲染出的端点清单或直接查看 docs/lms-openapi.yaml想新增一个后台异步任务按 docs/how-tos/celery.rst 的规范编写任务并在 lms/envs/production.py 的EXPLICIT_QUEUES及 CMS 对应配置中登记队列想了解某个功能开关或设置项查阅 docs/references/featuretoggles.rst 与 docs/references/settings.rst想理解某项架构决策的来龙去脉在 docs/decisions/ 中按编号检索对应 ADR想深入了解某模块的实现细节从 docs/references/docstrings/ 的模块 docstring 索引切入对应源码目录。需要说明的是仓库中的文档源文件仅供阅读与本地构建参考如在docs/目录执行make html生成站点若需要向 Open edX 贡献新的文档或代码应遵循社区规定的提交流程而文档内容本身的权威发布渠道为 docs.openedx.org 文档站点。【免费下载链接】openedx-platformThe Open edX LMS Studio, powering education sites around the world!项目地址: https://gitcode.com/GitHub_Trending/ed/openedx-platform创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Open edX edx-platform 开发者文档体系导读：从文档门户到源码级实践指南
Open edX edx-platform 开发者文档体系导读从文档门户到源码级实践指南【免费下载链接】openedx-platformThe Open edX LMS Studio, powering education sites around the world!项目地址: https://gitcode.com/GitHub_Trending/ed/openedx-platformedx-platformOpen edX 的 LMS 与 Studio 核心仓库在 docs/ 目录下维护了一套自包含的开发者文档体系而 docs/index.rst 正是这套体系的总门户它定义了文档板块的划分、构建入口、外部文档资源引用与版本变更脉络。本文将以此门户为骨架逐一展开每个板块指向的真实技术内容——从 Celery 任务队列路由的实战规范到 REST API 的 JWT 认证调用、Feature Toggle 与 Settings 参考、架构决策记录ADR的演进历史——并结合仓库源码如 lms/envs/production.py与 Sphinx 构建配置帮助你快速定位任意模块的开发文档理解文档背后对应的实现机制。文档门户的定位与总体结构docs/index.rst是 Sphinx 文档树的根页面master_doc承担三类职责划分文档板块通过两个toctree指令将全部文档组织为「可见目录」与「隐藏目录」两级结构提供主题化导航使用sphinx_design扩展的grid/grid-item-card指令将文档按 How-tos、References、Concepts、Hooks and Extensions、App Documentation 五个主题呈现为卡片式入口记录变更历史在页面底部以 Change History 章节追溯文档体系自 2014 年以来的演进。从目录树可以看出门户共收纳了以下文档目录均为仓库根下的真实路径板块文档目录典型主题How-tos操作指南docs/how-tos/Celery 任务编写、REST API 调用References参考手册docs/references/LMS API 清单、Settings、Feature Toggles、认证代码示例Concepts概念指南docs/concepts/扩展点、测试策略、前端开发、REST API 设计Hooks and Extensionsdocs/extensions/TinyMCE 插件等扩展机制App Documentationdocs/decisions/架构决策记录ADR与各应用文档其中「可见目录」:maxdepth: 1的 toctree只列出 docstrings 索引其余板块通过:hidden:属性的 toctree 收录再以卡片形式在前端展示——这是 Sphinx 文档门户的典型组织方式。文档构建系统Sphinx 配置与构建命令文档门户本身只是一份.rst源文件真正让它变成可浏览 HTML 的是配套的构建配置。仓库根下的 docs/conf.py 是 Sphinx 构建器的核心配置文件其中有几个值得注意的工程细节复用 Django 环境构建时通过sys.path.insert(0, root)将仓库根目录加入PYTHONPATH并默认设置DJANGO_SETTINGS_MODULE docs.docs_settings见 docs/docs_settings.py随后调用django.setup()。这使得文档可以直接导入 LMS 与 Studio 的全部代码支撑sphinx-apidoc自动生成 docstring 文档。动态生成参考内容extensions列表中启用了code_annotations.contrib.sphinx.extensions.featuretoggles与...settings两个扩展见 docs/conf.py它们负责在构建时扫描源码中的feature_toggle与settings注解自动生成 docs/references/featuretoggles.rst 与 docs/references/settings.rst 中的完整清单——这正是这两份参考手册能保持与代码同步的原因。API 文档嵌入通过sphinxcontrib.openapi扩展与.. openapi::指令将 docs/lms-openapi.yamlOpenAPI 规范文件直接渲染为 LMS API 文档。重定向管理使用rediraffe与sphinx_reredirects扩展维护文档迁移后的链接docs/redirects.txt 记录了所有历史路径到新路径的映射。构建入口定义在 docs/Makefile使用标准sphinx-build默认开启-j auto并行编译产物输出到_build/目录。常用命令# 在 docs/ 目录下执行 make html # 生成 HTML 文档 make clean # 清理构建产物含自动生成的 cms/common/lms/openedx 目录 make update_redirects # 生成因文件移动而缺失的重定向记录 make check_redirects # 校验所有移动过的文件是否都有重定向How-tos面向实战的操作指南docs/index.rst的「How-tos」卡片指向 docs/how-tos/index.rst以:glob:递归收录该目录下全部文档当前包含两份核心指南docs/how-tos/celery.rst如何编写 Celery 任务与 docs/how-tos/use_the_api.rst如何使用 REST API。编写 Celery 任务的队列路由规范docs/how-tos/celery.rst 记录了一次重要的技术演进随着 Celery 升级到 4.4旧版基于类的自定义路由器失效edx-platform 因此迁移到新的 Task Router API改用函数式路由 显式队列字典的方案。该文档确立了两条关键规范不再使用task装饰器中的routing_key参数Celery 新版本中该参数已不再把任务路由到对应 key 的队列继续使用会产生误导。通过EXPLICIT_QUEUES字典声明任务队列在 LMS 与 CMS 的 Django settings 中各维护一份EXPLICIT_QUEUES需要将任务路由到非默认队列时按以下模式登记文档原文示例lms.djangoapps.grades.tasks.compute_all_grades_for_course: { queue: POLICY_CHANGE_GRADES_ROUTING_KEY},该文档特别强调了一个易踩坑的注意点任务加入 LMS 的EXPLICIT_QUEUES后只有从 LMS 环境触发才会被路由到指定队列若需要从 CMS 环境也触发该任务则必须在 CMS 的EXPLICIT_QUEUES中重复登记。这条规范在源码中得到了完整印证在 lms/envs/production.py 的######## CELERY ROUTING ########配置段中可以看到真实生效的EXPLICIT_QUEUES定义例如EXPLICIT_QUEUES { openedx.core.djangoapps.content.course_overviews.tasks.async_course_overview_update: { queue: GRADES_DOWNLOAD_ROUTING_KEY}, lms.djangoapps.bulk_email.tasks.send_course_email: { queue: BULK_EMAIL_ROUTING_KEY}, lms.djangoapps.grades.tasks.recalculate_course_and_subsection_grades_for_user: { queue: POLICY_CHANGE_GRADES_ROUTING_KEY}, lms.djangoapps.grades.tasks.recalculate_subsection_grade_v3: { queue: SINGLE_LEARNER_COURSE_REGRADE_ROUTING_KEY}, ... }从源码结构看文档示例中的compute_all_grades_for_course任务在后来的演进中已被拆分/重命名为recalculate_course_and_subsection_grades_for_user等更细粒度的任务但任务名 → 队列名的字典登记模式始终保持不变。各路由 key 在 lms/envs/mock.yml 中也有定义如POLICY_CHANGE_GRADES_ROUTING_KEY: edx.lms.core.default说明该机制贯穿 mock、production 等多套环境配置。使用 REST APIOAuth2 客户端凭据 JWT 认证docs/how-tos/use_the_api.rst 是一份完整的端到端实操指南解决如何向 edx-platform REST API 发起认证请求这一核心问题。它的前置假设包括能访问 edx-platform 的 Django Admin/admin、准备一个用于发起请求的用户UserA、以及 LMS 运行在https://lms.example.com。完整步骤如下原文全部保留打开https://lms.example.com/admin/oauth2_provider/application/点击Add Application为用户 UserA 创建应用客户端类型选择Confidential机密型授权类型选择Client Credentials客户端凭据为应用命名保存后记录下client_id与client_secret用这两个凭证换取 JWT 访问令牌。文档给出了可直接运行的 Python 换取 JWT 的代码import base64 import requests client_id vovj0AItd9EnrOKjkDli0HpSF9HoooaTY9yueafn # Client secrets should not be exposed in your code, we put it here to # make the example more clear. client_secret a3Fkwr24dfDSlIXt3v3q4Ob41CYQNZyGmtK8Y8ax0srpIa2vJON3OC5Rvj1i1wizsIUv1W1qM1Q2XPeuyjucNixsHXZsuw1dn2B9nH3IyjSvuFb5KoydDvWX8Hx8znqD credential f{client_id}:{client_secret} encoded_credential base64.b64encode(credential.encode(utf-8)).decode(utf-8) headers {Authorization: fBasic {encoded_credential}, Cache-Control: no-cache} data {grant_type: client_credentials, token_type: jwt} token_request requests.post( http://lms.example.com/oauth2/access_token, headersheaders, datadata ) access_token token_request.json()[access_token]得到 JWT 后即可携带Authorization: JWT access_token请求头调用任意 API 端点文档以获取 UserA 的全部选课为例enrollment_request requests.get( http://lms.example.com/api/enrollment/v1/enrollment, headers{Authorization: fJWT {access_token}}, )该流程对应的后端实现位于common/djangoapps/third_party_auth与openedx/core/djangoapps/oauth_dispatch等模块OAuth2 token 端点即oauth2/access_token认证方式可进一步参考 docs/references/auth_code_samples.rst。References与代码实时同步的参考手册「References」板块由 docs/references/index.rst 组织内容分三类API 参考docs/references/lms_apis.rst 通过.. openapi:: ../lms-openapi.yaml指令直接渲染 docs/lms-openapi.yaml 中定义的 LMS API 端点清单文档还提示先阅读 docs/how-tos/use_the_api.rst 学习认证方式两者形成认证教程 端点清单的闭环。自动生成的配置清单docs/references/featuretoggles.rst 与 docs/references/settings.rst 分别列出所有 Open edX Feature Toggle 与 Django 设置项由code_annotations的 Sphinx 扩展在构建时从源码注解自动生成用于在生产环境手动启用/禁用功能。这类 Toggle 在源码中对应openedx/core/toggles.py的WaffleFlag/WaffleSwitch体系。docstring 索引docs/references/docstrings/ 下按 CMS、LMS、common 分层组织模块级 docstring 文档如 docs/references/docstrings/lms_index.rst依赖 docs/conf.py 中对仓库根的sys.path配置实现跨模块导入。Concepts理解平台设计的关键概念「Concepts and Guides」板块docs/concepts/index.rst是理解 edx-platform 设计哲学的入口当前收录docs/concepts/extension_points.rst扩展点概念说明如何在不动核心代码的前提下扩展平台docs/concepts/testing/testing.rst测试策略与测试金字塔模型docs/concepts/frontend/ 下的javascript.rst、styling.rst、bootstrap.rst前端开发规范docs/concepts/rest_apis.rstREST API 设计约定是 docs/how-tos/use_the_api.rst 的 seealso 关联文档。docs/index.rst的卡片中还列出了 docs/concepts/testing/testing.rst 与 docs/concepts/frontend/javascript.rst 作为 Concepts 板块的代表条目。Hooks and Extensions扩展机制专题「Hooks and Extensions」卡片聚焦平台的可扩展能力TinyMCE 插件docs/extensions/tinymce_plugins.rst 介绍富文本编辑器的自定义插件机制对应的实现主要位于 CMS 与xmodule的静态资源中Hooks 扩展框架门户通过外部链接指向 docs.openedx.org 的 Hooks Extensions Framework 文档说明该主题的权威说明已随文档体系外迁但仓库内 docs/concepts/extension_points.rst 仍然保留着本地的扩展点概念说明。App Documentation架构决策记录与演进史「App Documentation」卡片指向 docs/decisions/index.rst收录了 edx-platform 全部架构决策记录ADR——这是文档体系中最有历史价值的部分。截至当前仓库docs/decisions/ 下共有 40 余条按编号排列的决策记录如0000-static-asset-plan.rst、0006-role-of-xblock.rst、0013-cms-vs-studio.rst、0022-settings-simplification.rst、0037-api-versioning-strategy.rst、0038-standardize-rest-api-url-structure.rst等覆盖静态资源方案、XBlock 定位、CMS 与 Studio 的关系、设置简化、API 版本化策略等关键架构话题。这些 ADR 对理解当前代码为什么长这样极有价值。变更历史文档体系的演进脉络docs/index.rst底部的 Change History 完整记录了文档组织方式的演变April 2025文档迁移至 docs.openedx.org因此门户中大量出现指向外部文档空间的说明Jun 30, 2023新增 API、Feature Toggle 与 Settings 文档并重新组织文档布局本次重组形成了如今的 How-tos / References / Concepts 分类December 2020新增关于 Celery 任务编写新协议的文档即EXPLICIT_QUEUES路由规范April 2019恢复 API 与仓库级文档构建May 2017清空本地 docs 目录、从零重建当前文档体系的上一次大规模重构起点January 13, 2015 / November 3, 2014开发者指南与若干子项目文档迁入独立的 edx-documentation 仓库。这段历史解释了当前仓库文档的形态本地 docs/ 保持精简的开发者文档而面向用户与一般开发者的大部头指南托管在独立文档站点同时通过 docs/redirects.txt 与 Makefile 中的update_redirects/check_redirects目标保证历史链接不失效。如何基于门户快速定位所需文档在 edx-platform 中按需查阅文档可遵循以下路径想调用某个 REST API先读 docs/how-tos/use_the_api.rst 完成认证配置再对照 docs/references/lms_apis.rst 渲染出的端点清单或直接查看 docs/lms-openapi.yaml想新增一个后台异步任务按 docs/how-tos/celery.rst 的规范编写任务并在 lms/envs/production.py 的EXPLICIT_QUEUES及 CMS 对应配置中登记队列想了解某个功能开关或设置项查阅 docs/references/featuretoggles.rst 与 docs/references/settings.rst想理解某项架构决策的来龙去脉在 docs/decisions/ 中按编号检索对应 ADR想深入了解某模块的实现细节从 docs/references/docstrings/ 的模块 docstring 索引切入对应源码目录。需要说明的是仓库中的文档源文件仅供阅读与本地构建参考如在docs/目录执行make html生成站点若需要向 Open edX 贡献新的文档或代码应遵循社区规定的提交流程而文档内容本身的权威发布渠道为 docs.openedx.org 文档站点。【免费下载链接】openedx-platformThe Open edX LMS Studio, powering education sites around the world!项目地址: https://gitcode.com/GitHub_Trending/ed/openedx-platform创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考