[mkdocs] Add github action that tests the build of the example pages
未关闭
还没有人认领这个 Issue。
bug
P1
- 主要语言
- Python
- 星标
- 18.8k
- 派生
- 2.8k
- 平均合并
- 16 小时 26 分钟
- 30 天内合并 PR
- 21
描述
Right now we build the examples from jupyter notebooks here
https://github.com/plotly/plotly.py/blob/main/.circleci/config.yml#L356-L388
If any notebook outputs an error the build fails and the docs won't publish
We need to implement something similar for the new docs so we don't end up showing failures on published pages
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
先阅读 .circleci/config.yml 第 356-388 行中的 notebook 构建步骤，并将其与新的 MkDocs 示例页面构建进行比较。定义 GitHub Actions 检查，使 notebook 输出错误在文档发布前导致构建失败；完成标准是 workflow 能检测到这些失败。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- github-actions, jupyter-notebook, python
- 领域
- build-system, ci-cd, documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100