Sphinx の動作環境を作る

Windows 上に Sphinx の実行環境を構築します。必要なアプリケーションです。

  • Miniconda

  • Sphinx

  • テキストエディター

テキストエディターは UTF-8 が扱えれば、好みのものをご使用ください。



Miniconda をインストールする

  1. ブラウザーで Miniconda のページを開く → Miniconda3 Windows 64-bit をクリック

    ../_images/2020-02-29_20h35_52.png

  2. ファイルを開く をクリック

    ../_images/2020-02-29_20h36_24.png

  3. Next をクリック

    ../_images/2020-02-29_20h36_42.png

  4. I Agree をクリック

    ../_images/2020-02-29_20h36_56.png

  5. Next をクリック

    ../_images/2020-02-29_20h37_02.png

  6. Next をクリック

    ../_images/2020-02-29_20h37_09.png

  7. Install をクリック

    ../_images/2020-02-29_20h37_16.png

  8. インストール中

    ../_images/2020-02-29_20h37_22.png

  9. Next をクリック

    ../_images/2020-02-29_20h38_01.png

  10. Learn more ・・・Learn how ・・・ のチェックを外す → Finish をクリック

    ../_images/2020-02-29_20h38_14.png

  11. Miniconda のインストールが終了するとメニューに "Anaconda Powershell Prompt(Miniconda3)" と "Anaconda Prompt(Miniconda3)" が登録されます

    ../_images/2020-02-29_20h38_43.png

Sphinx をインストールする

  1. "Anaconda Powershell Prompt(Miniconda3)" を起動

    ../_images/2020-02-29_23h00_08.png

  2. Sphinx をインストール

    pip install -U Sphinx

    ../_images/2020-02-29_23h25_49.png ../_images/2020-02-29_23h27_01.png

  3. Sphinx のバージョン確認

    pip show sphinx

    ../_images/2020-02-29_23h27_20.png

テキストエディターをインストールする

UTF-8 を扱えるテキストエディターであれば何でも良いです。ここでは Visual Studio Code を紹介します。

  1. ブラウザーで Visual Studio Code – コード エディター | Microsoft Azure のページを開く → 今すぐ無料でダウンロードする をクリック

    ../_images/2020-03-01_08h17_28.png

  2. Windows 用の 64 bit をクリック

    ※ この手順では System Installer を使用しています。

    ../_images/2020-03-01_08h17_54.png

    注釈

    • インストールするパソコンを自分だけが使用しているのであれば User Installer / System Installer のどちらでも変わりはないです。

    • インストールするパソコンを他の方と共同で使用しているのであれば使用環境(条件)によりますが User Installer が望ましいと思います。

    User Installer
    • インストールしたユーザーだけが使用できる

    • Windows にログイン中のユーザーの領域 ( "%HOMEPATH%" フォルダー内 )にインストールする

    System Installer
    • 誰でも使用できる

    • "C:¥Program Files" フォルダー内にインストールする

    • インストール時に管理者権限が必要


  3. ファイルを開く をクリック

    ../_images/2020-03-01_08h18_24.png

  4. 同意する(A) を選択 → 次へ(N) をクリック

    ../_images/2020-03-01_08h19_13.png

  5. 次へ(N) をクリック

    ../_images/2020-03-01_08h19_31.png

  6. 次へ(N) をクリック

    ../_images/2020-03-01_08h19_45.png

  7. 追加タスクは必要なものをチェック → 次へ(N) をクリック

    ../_images/2020-03-01_08h20_15.png

  8. インストール(I) をクリック

    ../_images/2020-03-01_08h20_26.png

  9. インストール中

    ../_images/2020-03-01_08h20_37.png

  10. Visual Studio Code を実行する のチェックを外す → 完了(F) をクリック

    ../_images/2020-03-01_08h20_53.png

  11. インストールが終了するとメニューに "Visual Studio Code" が登録されます

    ../_images/2020-03-01_08h22_13.png