使用 GitHub Codespaces 进行 NumPy 开发#
文档的这一部分将指导您完成:
使用 GitHub Codespaces 作为您的 NumPy 开发环境
在 GitHub 上创建 NumPy 存储库的个人 fork
GitHub Codespaces 和 VSCode 桌面应用程序的快速浏览
在 GitHub Codespaces 中处理 NumPy 文档
GitHub Codespaces#
GitHub Codespaces 是一项提供基于云的开发环境的服务,因此您不必在本地计算机上安装任何内容或担心配置.
什么是 codespace?#
codespace 是 Codespaces 的一个实例 - 因此是一个托管在云中的开发环境.每个 codespace 都在 GitHub 托管的虚拟机上运行.您可以选择要使用的机器类型,具体取决于您需要的资源.有多种类型的机器可用,从 2 核处理器,4 GB RAM 和 32 GB 存储开始.您可以从浏览器,Visual Studio Code,JetBrains Gateway 应用程序或使用 GitHub CLI 连接到 codespace.
Fork NumPy 仓库#
作为贡献者,处理 NumPy 代码库的最佳方式是首先 fork 该仓库.
浏览到你的 fork. 你的 fork 将有一个类似 inessapawson/numpy 的 URL,但
inessapawson会替换成你的 GitHub 用户名.
启动 GitHub Codespaces#
你可以从仓库主页上的绿色 “<> Code” 按钮创建一个 codespace,然后选择 “Codespaces”,或者点击此链接 open .
快速工作区导览#
你可以在 codespace 中使用你选择的工具开发代码:
一个命令行 shell,通过使用 GitHub CLI 发起的 SSH 连接._
JetBrains IDE 之一,通过 JetBrains Gateway._
Visual Studio Code 桌面应用程序._
一个基于浏览器的 Visual Studio Code 版本._
在本快速入门中,我们将使用 VSCode 桌面应用程序作为编辑器.如果你之前没有使用过它,请参阅入门 VSCode docs ,熟悉一下这个工具.
你的工作区将类似于下图:
使用 GitHub Codespaces 的开发工作流程#
本文档的 开发工作流程 部分包含有关 NumPy 开发工作流程的信息. 在开始贡献之前,请务必查看此内容.
渲染 NumPy 文档#
你可以在 构建 NumPy API 和参考文档 部分找到关于如何使用 Sphinx 渲染文档的详细文档.
文档在你的 codespace 初始化期间会被预先构建.所以一旦这个任务完成,你主要有两种方式在 GitHub Codespaces 中渲染文档.
常见问题解答和故障排除#
如果我不使用我的 codespace,它会保持活动状态多长时间? 如果你让你的 codespace 在没有交互的情况下运行,或者如果你在没有明确停止它的情况下退出你的 codespace,默认情况下,codespace 将在 30 分钟不活动后超时. 你可以自定义你创建的新 codespace 的超时时间.
我可以回到之前的 codespace 吗? codespace 的生命周期从你创建 codespace 开始,到你删除它结束. 你可以断开并重新连接到一个活动的 codespace,而不会影响其运行的进程. 你可以停止并重新启动一个 codespace,而不会丢失你对项目所做的更改.