使用 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 内存和 32 GB 存储空间开始。您可以从浏览器、Visual Studio Code、JetBrains Gateway 应用程序或使用 GitHub CLI 连接到 codespace。
派生(Fork)NumPy 仓库#
作为贡献者,处理 NumPy 代码库的最佳方式是首先派生(fork)该仓库。
浏览至 GitHub 上的 NumPy 仓库,然后 创建您自己的派生(fork)。
浏览您的派生(fork)。您的派生(fork)将有一个类似 inessapawson/numpy 的 URL,只是将
inessapawson
替换为您的 GitHub 用户名。
启动 GitHub Codespaces#
您可以从仓库主页上的绿色“<> Code”按钮创建 codespace 并选择“Codespaces”,或者点击此链接 打开。
快速工作区导览#
您可以使用以下任一工具在 codespace 中开发代码
命令行 shell,通过使用 GitHub CLI 启动的 SSH 连接。
JetBrains IDE 之一,通过 JetBrains Gateway。
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,而不会丢失您对项目所做的更改。