Использование GitHub Codespaces для разработки NumPy#

Этот раздел документации проведёт вас через:

  • использование GitHub Codespaces для вашей среды разработки NumPy

  • создание персональной форк-копии репозитория NumPy на GitHub

  • краткий обзор GitHub Codespaces и настольного приложения VSCode

  • работа над документацией NumPy в GitHub Codespaces

GitHub Codespaces#

GitHub Codespaces это сервис, предоставляющий облачные среды разработки, чтобы вам не приходилось ничего устанавливать на локальной машине или беспокоиться о конфигурации.

Что такое codespace?#

Codespace — это экземпляр Codespaces, то есть среда разработки, размещённая в облаке. Каждый codespace работает на виртуальной машине, предоставляемой GitHub. Вы можете выбрать тип машины, который хотите использовать, в зависимости от необходимых ресурсов. Доступны различные типы машин, начиная с 2-ядерного процессора, 4 ГБ оперативной памяти и 32 ГБ хранилища. Вы можете подключиться к codespace из браузера, из Visual Studio Code, из приложения JetBrains Gateway или с помощью GitHub CLI.

Форк репозитория NumPy#

Лучший способ работы с кодом NumPy в качестве участника — сначала создать форк репозитория.

  1. Перейдите к Репозиторий NumPy на GitHub и создайте собственную ветку.

  2. Перейдите к своей форке. Ваша форка будет иметь URL-адрес вида inessapawson/numpy, за исключением замены вашего имени пользователя GitHub на inessapawson.

Запуск GitHub Codespaces#

Вы можете создать codespace из зеленой кнопки "<> Code" на главной странице репозитория и выбрать "Codespaces", или нажмите эту ссылку открыть.

Быстрый обзор рабочей области#

Вы можете разрабатывать код в codespace, используя инструмент по вашему выбору:

  • командная оболочка, через SSH-соединение, инициированное с использованием GitHub CLI.

  • одна из IDE JetBrains, через JetBrains Gateway.

  • приложение Visual Studio Code._

  • браузерная версия Visual Studio Code._

В этом кратком руководстве мы будем использовать настольное приложение VSCode в качестве редактора. Если вы раньше не использовали его, см. раздел Начало работы Документация VSCode чтобы ознакомиться с этим инструментом.

Ваше рабочее пространство будет выглядеть примерно так, как на изображении ниже:

Рабочий процесс разработки с GitHub Codespaces#

The Рабочий процесс разработки раздел этой документации содержит информацию о рабочем процессе разработки NumPy. Обязательно проверьте это перед началом работы над вашими вкладами.

Рендеринг документации NumPy#

Подробную документацию о том, как работает рендеринг документации с помощью Sphinx, можно найти в Создание API NumPy и справочной документации раздел.

Документация предварительно собирается во время инициализации вашего codespace. Поэтому после завершения этой задачи у вас есть два основных варианта для отображения документации в GitHub Codespaces.

Часто задаваемые вопросы и устранение неполадок#

Как долго мое пространство кода остается активным, если я его не использую? Если вы оставите codespace работающим без взаимодействия или выйдете из него без явной остановки, по умолчанию codespace завершит работу через 30 минут бездействия. Вы можете настроить длительность периода таймаута для новых создаваемых codespace.

Могу ли я вернуться к предыдущему рабочему пространству? Жизненный цикл кодового пространства начинается, когда вы создаете кодовое пространство, и заканчивается, когда вы его удаляете. Вы можете отключиться и снова подключиться к активному кодовому пространству, не влияя на его запущенные процессы. Вы можете остановить и перезапустить кодовое пространство, не теряя изменений, внесенных в ваш проект.