Windowsでのインストール方法

このガイドでは次のトピックを紹介します:

  1. Pythonのインストール (ソースファイルをHTMLページへ変換するために必要)

  2. Installing Git and Downloading the Repository

  3. ビルド環境のセットアップ

Pythonのインストール

  1. Download the Python installation package for Windows. In this guide version 3.9.x is used.

  2. ウィザードを通してインストールしてください。必ずPATHにPythonを追加してください。(画像参照):

    ../../_images/about_contribute_install_windows_installer.png

    このオプションは make スクリプトでマニュアルを生成するために、必ず有効にしてください。

    他の設定は初期設定のままで構いません。

Installing Git and Downloading the Repository

In this guide, we will use the official Git client, though any Git client will do.

  1. Download and install Git for Windows.

  2. Simply check out the Blender Manual's repository using:

    cd ~
    git lfs install
    git clone https://projects.blender.org/blender/blender-manual.git
    
  3. The repository will now be downloaded which may take a few minutes depending on your internet connection.

注釈

This process can be completed using a graphical Git client, in that case you will just use the repository address in the URL field provided by your client:

https://projects.blender.org/blender/blender-manual.git

ビルド環境のセットアップ

Tip

It is recommended to setup and activate a virtual Python environment where dependencies will be installed:

python3 -m venv .venv
.venv/Scripts/activate

Repeat the .venv/Scripts/activate command to re-activate the virtual environment, whenever you open a new terminal to build the documentation.

  • コマンドプロンプトを開きます。(「管理者として実行」で開いてください)

  • Enter the blender-manual folder which was just added by git clone:

    cd C:\blender-manual
    
  • そのフォルダーの中には requirements.txt というテキストファイルがあり、内容はディペンデンシーのリストになっています。ディペンデンシーをPythonの pip コマンドを使ってインストールしてください:

    pip install -r requirements.txt
    
  • 問題なく完了すると次のようなメッセージが表示されます:

    Successfully installed Jinja2 MarkupSafe Pygments Sphinx docutils sphinx-rtd-theme Cleaning up...
    

セットアップの途中で警告が出るかもしれませんが、構わないでください。ただし、エラーが出たら問題と成り得ます。

注釈

時々ディペンデンシーを最新版にした方がいいでしょう。最新版にするには:

pip install -r requirements.txt --upgrade