貢献#

このドキュメントとライブラリの改善にご協力いただきありがとうございます！

このドキュメントが不明確または手順が欠落している場合は、issue を開いてください。

開発ワークフロー#

コードまたはドキュメントの貢献にご興味がある場合は、開発環境に Sphinx-Gallery の開発バージョンをインストールすることを強くお勧めします。git/github のワークフローに慣れていない場合は、Github のプロジェクトへの貢献に関するガイドを参照してください。

このガイドは、Github のワークフローに精通していることを前提とし、Sphinx-Gallery への貢献に特有の側面を重点的に説明します。

専用環境の作成#

システム上の他の Python インストールから分離するために、Sphinx Gallery を開発するための仮想環境を作成することを強くお勧めします。

新しい仮想環境を作成します

python -m venv <file folder location>

次のいずれかを使用して仮想環境をアクティブ化します

source <file folder location>/bin/activate  # Linux/macOS
<file folder location>\Scripts\activate.bat  # Windows cmd.exe
<file folder location>\Scripts\Activate.ps1

依存関係のインストール#

Sphinx Gallery の依存関係のほとんどは、pyproject.toml にリストされており、これらのファイルからインストールできます

python -m pip install --editable ".[dev]"

Sphinx Gallery では、setuptools がインストールされている必要があります。通常は python にパッケージされていますが、必要に応じて pip を使用してインストールできます

python -m pip install setuptools

開発用のインストール#

編集可能インストールとは、環境 Python が常にコードの最新の変更バージョンを使用することを意味します。Sphinx Gallery を編集可能モードでインストールするには、sphinx-gallery ディレクトリにいることを確認してください

cd sphinx-gallery

次に、編集可能フラグを使用してインストールします

python -m pip install -e .

インストール確認#

テストを実行して、すべて設定されていることを確認します

python -m pytest sphinx_gallery

ドキュメントをビルドして確認します

cd doc
make html

pre-commit フックのインストール#

pre-commit フックは、貢献されたコードとドキュメントのスペルチェックや書式設定などを確認します。pre-commit フックを設定するには

python -m pip install pre-commit
pre-commit install

ガイドライン#

テスト#

すべてのコード貢献はテストする必要があります。テストフレームワークにはpytestを使用し、テストページをビルドするためにtinybuildを使用します。テストは、sphinx_gallery/testsにあります。

tinybuild#

tinybuildは、tinybuild/docからmake htmlを実行して、従来のビルド体験を得ることができる最小限の完全な sphinx ドキュメントビルドとして設計されています。

tinybuildは、tests/test_full.pyで実行され、tests/doc/tinybuildにある.rstドキュメントファイルを使用してテストページをビルドします。テストでは、.rstファイル内のディレクティブの動作を検証するために、html出力を調べます。

貢献#