使用 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。
分叉 NumPy 仓库#
作为贡献者参与 NumPy 代码库的最佳方式是首先分叉(fork)该仓库。
浏览到 GitHub 上的 NumPy 仓库 并 创建您自己的分叉。
浏览到您的分叉。您的分叉将具有一个类似 inessapawson/numpy 的 URL,只是其中 `
inessapawson` 被替换为您的 GitHub 用户名。
启动 GitHub Codespaces#
您可以在仓库主页的绿色“<> Code”按钮上选择“Codespaces”来创建 codespace,或者单击此链接 打开。
快速工作空间概览#
您可以使用您选择的工具在 codespace 中开发代码
通过使用 GitHub CLI 发起的 SSH 连接,访问命令行 shell。
通过 JetBrains Gateway,使用 JetBrains IDE 之一。
使用 Visual Studio Code 桌面应用程序。
使用基于浏览器的 Visual Studio Code 版本。
在本快速入门中,我们将使用 VSCode 桌面应用程序作为编辑器。如果您以前未使用过它,请参阅入门 VSCode 文档 以熟悉该工具。
您的工作空间将与下图类似
使用 GitHub Codespaces 的开发工作流#
本教程的 开发工作流 部分包含有关 NumPy 开发工作流的信息。在开始您的贡献之前,请务必查看此部分。
渲染 NumPy 文档#
您可以在 构建 NumPy API 和参考文档 部分找到关于 Sphinx 如何渲染文档的详细说明。
文档在您的 codespace 初始化过程中已预先构建。因此,一旦此任务完成,您主要有两个选项可以在 GitHub Codespaces 中渲染文档。
常见问题解答和故障排除#
如果我不使用 codespace,它会保持活动多久? 如果您让 codespace 在不进行交互的情况下运行,或者在没有明确停止的情况下退出 codespace,则默认情况下,codespace 将在闲置 30 分钟后超时。您可以自定义您创建的新 codespace 的超时时长。
我能回到以前的 codespace 吗? codespace 的生命周期始于您创建 codespace 并终于您删除它。您可以断开连接并重新连接到活动的 codespace,而不会影响其正在运行的进程。您可以停止并重新启动 codespace,而不会丢失对项目的更改。