Создание документации NumPy API и справочных материалов

NumPy

Поскольку большая часть основной документации извлекается из NumPy с помощью import numpy и анализа строк документации, вам сначала необходимо создать и установить его, чтобы была импортирована правильная версия. NumPy необходимо пересоздать и переустановить каждый раз, когда вы получаете последнюю версию репозитория перед генерацией документации. Это гарантирует синхронизацию версии NumPy и версии репозитория git.

Обратите внимание, что вы можете, например, установить NumPy в временную папку и соответствующим образом установить переменную среды PYTHONPATH. В качестве альтернативы, если вы используете виртуальные среды Python (например, conda, virtualenv или модуль venv), рекомендуется устанавливать NumPy в новую виртуальную среду.

Зависимости

Все необходимые зависимости для построения документации NumPy, за исключением Doxygen, можно установить с помощью:

pip install -r requirements/doc_requirements.txt

pip install --pre --force-reinstall --extra-index-url \
https://pypi.anaconda.org/scientific-python-nightly-wheels/simple \
-r requirements/doc_requirements.txt

В настоящее время для генерации API и справочной документации NumPy используется Sphinx вместе с Doxygen. Кроме того, для создания документации требуется расширение Sphinx plot_directive, которое поставляется с Matplotlib. Также используется numpydoc для отображения строк документации в сгенерированной API-документации. SciPy установлен, поскольку некоторые части документации требуют функций SciPy.

Для установки Doxygen, пожалуйста, проверьте официальные страницы скачивания и установки, или, если вы используете Linux, установите его через менеджер пакетов своей дистрибуции.

Подмодули

Если вы получили NumPy через git, также получите подмодули git, содержащие дополнительные части, необходимые для создания документации:

git submodule update --init