Jupyter Notebook：E2Eテストとドキュメントを一つに
2024-12-18
量子コンピューティングライブラリの開発において、著者はJupyter Notebookをユーザーガイドとエンドツーエンドテストの両方として活用しました。Notebook内で環境変数（SERVER_URLなど）を読み取ることで、パラメーター化を実現し、ユーザーと自動化されたCI/CDパイプラインの両方による実行を可能にしました。Notebookの実行方法として、簡潔なnbclientと、より柔軟なnbconvert/jqの2つの方法を検討しました。最終的に著者はnbclientの簡潔さを選択し、ドキュメントのメンテナンスとコードテストを効果的に統合することで、マージリクエストごとに両者の整合性を確保しています。
開発
E2Eテスト