Sphinxのインストール

SphinxはPythonを用いて書かれているため、Python (必要とされるバージョンは最低で2.7) とSphinxをインストールする必要があります。

Sphinx関係のパッケージは Python Package Index より入手可能です。

Gitリポジトリからスナップショットをダウンロードすることもできます。

いくつかの環境について導入方法を紹介します:

Debian/Ubuntu: パッケージシステムを利用してPythonをインストールします。

Ubuntu LinuxなどのDebian系のOSの場合は、以下のコマンドを使ってインストールできます。

$ apt-get install python-sphinx

他のLinuxディストリビューション

ほとんどのLinuxディストリビューションは、OSのパッケージ管理リポジトリにSphinxが用意されています。一般的なパッケージ名は “python-sphinx”, “python-Sphinx”, “sphinx” です。”sphinx”という名前をもつ別の用途のパッケージが他に2つあることに注意してください: 音声認識ツールキット(CMU Sphinx), フルテキスト検索データベース(Sphinx search)。

Mac OS X: MacPortsを利用してインストールします。

Mac OS Xの MacPorts を利用しているのであれば、下記のコマンド一発で、必要なものがすべてインストールされます。

$ sudo port install py27-sphinx

実行パスを設定するために port select コマンドを使って下さい:

$ sudo port select --set python python27
$ sudo port select --set sphinx py27-sphinx

which sphinx-quickstart を実行してインストールが完了しているか確認出来ます。

Windows: PythonとSphinxをインストールします。

Pythonのインストール

Windowsの場合は、Pythonが入っていない場合がほとんどだと思いますので、Pythonのインストールから説明します。すでにPythonを利用している人は、この項目を飛ばしてください。

https://www.python.org/ を開きます。Pythonの総本山です。英語が多いですが、恐れないで行きましょう!左側のサイドバーから、Quick Linksの中のWindows Installerをクリックしてダウンロードして、インストールします。

_images/pythonorg.png

注釈

Currently, Python offers two major versions, 2.x and 3.x. Sphinx 1.5 can run under Python 2.7, 3.4, 3.5, 3.6, with the recommended version being 2.7. This chapter assumes you have installed Python 2.7.

Windowsのインストーラに従がってインストールが完了させてください。

_images/installpython.jpg

インストールが完了したら、コマンドラインからPythonや sphinx-build を簡単に起動できるように、環境変数の PATH にPythonの実行ディレクトリをいくつか追加しましょう。

  • マイコンピュータのアイコンを右クリックして、プロパティダイアログを開きます

  • 詳細タブの下の方にある環境変数ボタンをクリックします

  • “Path” (または “PATH”) がすでに「システム環境変数」に存在する場合それを編集します。存在しない場合は “PATH” という名前で新しい変数を追加します。

  • 各パスはセミコロン ”;” で区切ります。

    • C:\Python27 – このフォルダーにPythonの実行可能なプログラムが含まれています
    • C:\Python27\Scripts – このフォルダーには、pip (下記参照) などでインストールするPythonパッケージの実行可能ファイルが含まれます

    これは Python 2.7 の場合です。別のバージョンのPythonを使用する場合や、他の場所にインストールしている場合は、 “27” の数字をそれに応じて変更してください。

  • コマンド プロンプト を実行しましょう。コマンドプロンプトウィンドウが表示されたら、 python と入力してEnterキーを押下します。Pythonのインストールが成功していれば、インストールしたPythonのバージョンと、プロンプト >>> が表示されます。 Ctrl+Z とEnterキーを入力して終了してください。

pipコマンドのインストール

Pythonには非常に有用な pip コマンドがあり、1コマンドでサードパーティー製のライブラリをダウンロード・インストールできます。このコマンドは、 Python Packaging Authority(PyPA)プロジェクトによって提供されています: https://groups.google.com/forum/#!forum/pypa-dev

pipをインストールするために、 https://bootstrap.pypa.io/get-pip.py をダウンロードしてどこかに保存してください。ダウンロード後に、コマンドプロンプトを起動して、get-pip.py を保存したディレクトリに移動して、以下のコマンドを実行します:

C:\> python get-pip.py

これで pip コマンドがインストールされました。次はSphinxのインストールです。

注釈

pip はPython-3.4.0もしくはPython-2.7.9以降のバージョンのPythonの公式インストール物に含まれています。

pipでSphinxインストール

pipのインストールが完了したら、以下の内容をコマンド プロンプトで入力します:

C:\> pip install sphinx

インストールが完了したら、 sphinx-build -h をコマンドプロンプトに入力します。インストールが問題なく完了していれば、Sphinxのバージョン番号とこのコマンドのオプション一覧が表示されます。

インストール作業は以上です。次は Sphinxの最初の一歩 に進んでください。