Jupyter Notebook:兼具文档和端到端测试的利器

2024-12-18

作者在开发量子计算库时,利用Jupyter Notebook编写用户指南,并巧妙地将其作为端到端测试的工具。通过在Notebook中读取环境变量(例如服务器URL),实现参数化,使其既能被用户运行,也能在CI/CD流水线中自动执行。作者比较了两种运行Notebook的方法:一种是直接使用nbclient执行,简单直接;另一种是结合nbconvert和jq处理输出,更灵活但较复杂。最终,作者选择了前者,有效地将文档维护和代码测试结合,确保每次合并请求都能保证文档和代码的完整性。