[mkdocs] Add github action that tests the build of the example pages
オープン
まだ誰も着手していません。
bug
P1
- 主要言語
- Python
- スター
- 18.8k
- フォーク
- 2.8k
- 平均マージ
- 16時間 26分
- マージ済み PR（30日）
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
.circleci/config.yml の356-388行にある notebook のビルド手順を読み始め、新しい MkDocs のサンプルページのビルドと比較します。notebook の出力エラーによってドキュメントの公開前にビルドが失敗するように GitHub Actions のチェックを定義します。完了条件は、workflow がそれらの失敗を検出することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- github-actions, jupyter-notebook, python
- 領域
- build-system, ci-cd, documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100