飞桨文档预览工具 - PaddlePaddle/docs GitHub Wiki

一、说明

当修改了 PaddlePaddle/Paddle 或 PaddlePaddle/docs 中关于飞桨文档的内容后，你需要检查修改后的格式是否正确无误，因此需要观察你修改PR的官网预览效果。

二、Docs 的预览

当你提交PR后，bot会自动发送该PR的预览链接，如下：

只需要等 Docs-New 的CI运行完成后（注意，目前要能运行至只差 approve 的状态，才能正常预览，否则可能会 Oops），就可以正常预览了。

三、Paddle 的预览

你可以在 Paddle PR 的描述区，提交PR并在 commit 阶段，加上 关键词 test=docs_preview 用于构建 Paddle PR 的预览，即英文文档预览。

Note：使用此方法，需要等 Paddle PR 的 PR-CI-Paddle-Doc-Preview 流水线通过后，才会正确的构建 Paddle 的预览。 并由paddle-bot触发回复：