Sphinxのインストール

概要

ライオンの顔像は `Python`_ _、Python 3.5+をサポートします。多くの第三者ライブラリの肩に設置されています `Docutils`_ _と `Jinja`_ _、Sphinxをインストールする際にインストールします。

Linux

Debian/Ubuntu

どちらかをインストールする python3-sphinx Vbl.使用 apt-get ：

$ apt-get install python3-sphinx

もしそれがまだ存在しなければ、これはPythonをインストールします。

Rhel CentOS

取り付ける python-sphinx Vbl.使用 yum ：

$ yum install python-sphinx

もしそれがまだ存在しなければ、これはPythonをインストールします。

その他の発行バージョン

Most Linux distributions have Sphinx in their package repositories. Usually the package is called python3-sphinx, python-sphinx or sphinx. Be aware that there are at least two other packages with sphinx in their name: a speech recognition toolkit (CMU Sphinx) and a full-text search database (Sphinx search).

マルコス！

以下のコマンドを使用してSphinxをインストールすることができます Homebrew _, MacPorts _、またはPythonリリース版の一部として(例えば Anaconda _.

自家製

$ brew install sphinx-doc

詳細についてはご参照ください `package overview`_ _.

MacPorts

どちらかをインストールする python3x-sphinx Vbl.使用 port ：

$ sudo port install py38-sphinx

実行可能ファイルパスを設定する場合は、ご利用ください port select 命令：

$ sudo port select --set python python38
$ sudo port select --set sphinx py38-sphinx

詳細についてはご参照ください `package overview`_ _.

ガラガラヘビ.

$ conda install sphinx

窓をあける

課題

これを包装し始めてもいいですか。

Most Windows users do not have Python installed by default, so we begin with the installation of Python itself. To check if you already have Python installed, open the Command Prompt (⊞Win-r and type cmd). Once the command prompt is open, type python --version and press Enter. If Python is installed, you will see the version of Python printed to the screen. If you do not have Python installed, refer to the `Hitchhikers Guide to Python's`__ Python on Windows installation guides. You must install `Python 3`__.

Pythonのインストール後、以下のコマンドを使用してSphinxをインストールすることができます pip それがそうです。参考にする pip installation instructions より多くの情報については、次のリンクをクリックしてください。

PyPIからのインストール

Sphinxパッケージは Python Package Index それがそうです。ソフトウェアパッケージをインストールするための第一選択ツールから PyPI はい。 pip それがそうです。このツールはすべての現代版のPythonとともに提供されます。

LinuxまたはMacOSでは、端末を開き、以下のコマンドを実行する必要があります。

$ pip install -U sphinx

On Windows, you should open Command Prompt (⊞Win-r and type cmd) and run the same command.

C:\> pip install -U sphinx

インストール後、キー入力 sphinx-build --version 命令プロンプトの下で。もしすべてが正常なら、あなたはインストールされたばかりのSphinxパッケージのバージョン番号を見るだろう。

以下の位置から設置する PyPI 最新の開発バージョンをインストールすることもできます。あなたは通常そうする必要はありませんが、最新の安定バージョンで可能なbugを見ると、それは有用かもしれません。そのために、お使いください --pre 旗。

$ pip install -U --pre sphinx

ドッケル

ライオンの顔像に関するDocker画像が公開されています Docker Hub それがそうです。2つの画像があります

前者はSphinxの標準的な用法に用いられ，後者は主にLaTeXを用いたPDF構築に用いられる.あなたの必要に応じて一つを選んでください。

注釈

Sphinxdoc/sphinx-latexpdfはTeXLiveパッケージを含む。画像は非常に大きいです(2 GBを超える！)。

ヒント

ドッキングステーション画像をご利用の際は、ご利用ください docker run ライオンのイメージコマンドを呼び出すコマンドです。例えば、以下のコマンドを使用してSphinxプロジェクトを作成することができます。

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

以下のコマンドを実行してHTML文書を構築することができます。

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

詳細については、お読みください `README file`_ _寄港画像。

自源設置

あなたは直接 `Git repository`_ _。これはRepoをクローンし，ローカルからクローンインストールすることで実現でき，直接通過するだけでよい. git それがそうです。

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

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

Gitリベートのスナップショットを以下の位置でダウンロードすることもできます `tar.gz`_ _または `zip`_ _FORMAT。ダウンロードして解凍すると、一緒にインストールすることができます pip 以上のように。