Sphinxのインストール¶

SphinxはPythonアプリケーションです。下記の方法のいずれかでインストールできます。

インストール後、以下のコマンドを実行してSphinxが利用可能かどうかを確認できます。

$ sphinx-build --version

これにより、Sphinxのバージョン番号が出力されます。

ヒント

ローカル開発では、一般的にグローバルではない環境（例えば venv または conda 環境）にSphinxをインストールすることをお勧めします。これにより、各Sphinxプロジェクトで個別のSphinxバージョンとサードパーティ製の拡張機能を使用できます。

PyPIパッケージ¶

Sphinxパッケージは、Python Package Index (PyPI)で公開されています。PyPIからパッケージをインストールするための推奨ツールはpipであり、すべての最新のPythonバージョンに含まれています。

以下のコマンドを実行します

$ pip install -U sphinx

ヒント

環境の再構築時の問題を避けるため、requirements.txtファイルでsphinxとサードパーティ製の拡張機能のバージョンを固定することをお勧めします。

$ pip install -r requirements.txt

または、Pythonパッケージのドキュメントを作成する場合は、依存関係をpyproject.tomlファイルに配置します。

$ pip install .[docs]

Condaパッケージ¶

condaを使用するには、anaconda、miniconda、miniforge、またはmicromambaなどのcondaベースのPythonディストリビューションが必要です。

Sphinxは、*anaconda main*チャンネル（Anaconda Inc.が保守）と

$ conda install sphinx

*conda-forge*コミュニティチャンネルの両方で利用可能です。

$ conda install -c conda-forge sphinx

OS固有のパッケージマネージャー¶

OS固有のパッケージマネージャーを使用して、システムにSphinxのグローバルバージョンをインストールできます。ただし、これは柔軟性が低く、異なるプロジェクト間で作業する場合に互換性の問題が発生する可能性があることに注意してください。

Linux¶

Debian/Ubuntu¶

apt-getを使用してpython3-sphinxをインストールします。

$ apt-get install python3-sphinx

まだインストールされていない場合、これによりPythonもインストールされます。

RHEL、CentOS¶

yumを使用してpython-sphinxをインストールします。

$ yum install python-sphinx

まだインストールされていない場合、これによりPythonもインストールされます。

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

ほとんどのLinuxディストリビューションでは、パッケージリポジトリにSphinxがあります。通常、パッケージ名はpython3-sphinx、python-sphinx、またはsphinxです。sphinxという名前のパッケージには、音声認識ツールキット（*CMU Sphinx*）と全文検索データベース（*Sphinx search*）の少なくとも2つの別のパッケージがあることに注意してください。

macOS¶

Sphinxは、Homebrew、MacPortsを使用してインストールできます。

Homebrew¶

$ brew install sphinx-doc

詳細については、パッケージの概要を参照してください。

MacPorts¶

portを使用してpython3x-sphinxをインストールします。

$ sudo port install py312-sphinx

実行可能ファイルのパスを設定するには、port selectコマンドを使用します。

$ sudo port select --set python python312
$ sudo port select --set sphinx py312-sphinx

詳細については、パッケージの概要を参照してください。

Windows¶

Sphinxは、Chocolateyを使用してインストールできます。

Chocolatey¶

$ choco install sphinx

これを実行する前に、Chocolateyをインストールする必要があります。

詳細については、chocolateyページを参照してください。

Docker¶

SphinxのDockerイメージはDocker Hubで公開されています。2種類のイメージがあります。

前者はSphinxの標準的な使用法に使用され、後者は主にLaTeXを使用したPDFビルドに使用されます。目的に合わせて選択してください。

注記

sphinxdoc/sphinx-latexpdfにはTeXLiveパッケージが含まれています。そのため、イメージは非常に大きくなります（2GB以上！）。

ヒント

Dockerイメージを使用する場合は、docker runコマンドを使用してsphinxコマンドを呼び出してください。例えば、以下のコマンドを使用してSphinxプロジェクトを作成できます。

$ docker run -it --rm -v /path/to/document:/docs sphinxdoc/sphinx sphinx-quickstart

そして、以下のコマンドを使用してHTMLドキュメントをビルドできます。

$ docker run --rm -v /path/to/document:/docs sphinxdoc/sphinx make html

詳細については、DockerイメージのREADMEファイルをお読みください。

ソースからのインストール¶

Gitリポジトリのクローンから直接Sphinxをインストールできます。これは、リポジトリをクローンしてローカルクローンからインストールするか、gitを介して直接インストールするかのいずれかで行うことができます。

$ git clone https://github.com/sphinx-doc/sphinx
$ cd sphinx
$ pip install .

$ pip install git+https://github.com/sphinx-doc/sphinx

tar.gzまたはzip形式でGitリポジトリのスナップショットをダウンロードすることもできます。ダウンロードして解凍したら、上記のようにpipでインストールできます。

このページの内容