赛题简介

赛题五：将 xdoctest 引入到飞桨框架工作流中

xdoctest 是一个示例代码自动执行和检查工具，可以自动执行 Python docstring 中的示例代码，并对示例代码输出进行检查。
本赛题，要求将 xdoctest 引入到飞桨框架的工作流中，利用 xdoctest 来自动检查示例代码运行正确，且输出结果匹配，以确保示例代码输出的一致性，进一步提高飞桨框架示例代码的质量。

更多信息参考 中国软件开源创新大赛：飞桨框架任务挑战赛

独立开发

RFC

• [Add]将 xdoctest 引入到飞桨框架工作流中v1 community#547

第一阶段

• [Change]修改目前 Paddle docs 中 COPY-FROM 的逻辑 docs#5941
• [Change]修改目前 Paddle docs 的代码检查方式 docs#5962
• [Add] Paddle 代码 CI 中引入 xdoctest 检查 #55295

第二阶段

• [Change] 更新文档《开发 API Python 端》与《API 文档书写规范》 docs#6096
• [Change] 不再兼容旧格式示例代码 #56573
• [Remove] 代码检查移交给 Paddle CI docs#6129

第三阶段

• 代码检查移交 收尾 此任务分解为：第二阶段最后一个任务，与第三阶段的两个收尾任务
• 清理遗留代码
  • [xdoctest][task cleanup 1-8] reformat example code with google style #57670
• 清理无 reason 的 skip 示例
• 清理 fluid 代码
  Update 20230922
  • commit 579103d91e, 未发现遗留使用 fluid 的示例
  • [Add] bad statement check #57421 已 merge，后续会检查此类示例

批量任务

• 修改目前 Paddle docs 中仍使用 code-block 的示例代码为 COPY-FROM docs#5957
• [xdoctest] 分批次修改已有代码的示例 #55629

其他任务

• 中英文 API 文档特性更新（官网 copy 功能）

@SigureMo @luotao1 @jzhang533 @sunzhongkai588

请悉知～ ：）