パッケージ管理ツールを利用したインストール(Ubuntu)¶

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

$ apt install python3-sphinx

pip を使ってインストールする(macOS, UNIX & Linuxディストリビューション共通)¶

macOS や Linux ディストリビューション、その他 UNIX OS の場合、システムで標準でインストールされているPython、もしくは自前でビルドしたPythonで Sphinx のインストールが可能です。

venv という Python3.3 以降に追加された仮想環境機能を利用して Sphinx 用の環境を作成し、Sphinx をインストールする手順を紹介します。

ターミナルソフトを起動し、コマンドを打ちこむ手順は以下の通りです。

1. 仮想環境をユーザのホームディレクトリ配下に .venv/mysphinx という名前で作成します。

$ make -p ~/.venv
$ python3 -m venv ~/.venv/mysphinx

2. 仮想環境に入ります

$ source ~/.venv/mysphinx/bin/activate

3. pip コマンドでインストールします。

$ pip install sphinx Pillow

# 正常にインストールが完了した場合の表示例
Successfully installed Jinja2-2.10 MarkupSafe-1.0 Pillow-4.3.0 Pygments-2.2.0 alabaster-0.7.10 babel-2.5.1 certifi-2017.11.5 chardet-3.0.4 colorama-0.3.9 docutils-0.14 idna-2.6 imagesize-0.7.1 olefile-0.44 pytz-2017.3 requests-2.18.4 six-1.11.0 snowballstemmer-1.2.1 sphinx-1.6.5 sphinxcontrib-websupport-1.0.1 urllib3-1.22

4. Sphinx がインストールされた事を確認しましょう。

$ sphinx-quickstart --version

# 正常にインストールが完了した場合の表示例
sphinx-quickstart 3.0.4

仮想環境から抜ける場合は deactivate と打ち込んでください。ターミナルをそのまま閉じても問題はありません。

pip install sphinx -U

インストール作業は以上です。次はプロジェクトを作るに進んでください。