Windowsへのインストール(スタンドアロンインストール)

警告

2017年現在、スタンドアロンインストール用のインストーラは更新が停止しています。Windowsへのインストールの手順を参照してください。

スタンドアロンインストーラは Python、Sphinx そしてよく利用される Sphinx 拡張群をひとつにまとめた Windows 用のインストールパッケージです。このスタンドアロンインストーラを利用することで、いくつものパッケージを個別に入れることなく、Sphinx 本体と関連するコンポーネントを一度にインストールできます。

スタンドアロンインストーラはみなさんの利用レポートをお待ちしております。レポート先はこちらメーリングリスト(We are looking forward to your usage reports for Standalone-installer. Earlier report is here:メーリングリスト)

Install standalone Sphinx

最新のSphinx standalone installerをダウンロードし実行してください。

注釈

Windows Vista以降で管理者権限が必要な場所へのインストールを行う場合は「右クリックして管理者権限で実行」してください。(管理権限は要求しないように作っています)

If you need privilege to install on WIndows Vista or after, You need toinstall with administrator privilege (right click and choose one).

これでパス設定を含めたインストールが行われます。

スタートメニューから、コマンドプロンプトを起動するか、「名前を指定して実行」でcmdと入力してみましょう。ウィンドウが表れたら、python[Enter]とタイプします。インストールしたPythonのバージョンを表す文章に続いて、>>>という文字が表示されればインストールは成功です。Ctrl+Zキーを押して終了しましょう。

これで完了です。インストールが終わったら、コマンドラインから、sphinx-quickstart[エンター]とタイプしてみます。以下のように表示されていればインストールは成功です。Ctrl+Cキーを押して中断しましょう。インストール作業は以上です。次はプロジェクトを作るに進んでください。

Welcome to the Sphinx 1.4 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]:

警告

もしも環境変数PYTHONPATHを設定している場合、正しく動作しない可能性があります。コマンドプロンプトでset PYTHONPATHと入力すると現在設定されているPYTHONPATHの値を確認することが出来ます。この値を完全に消してしまうか(この設定を必要とする他のプログラムが動作しなくなる可能性があるため、自己責任にてお願いします)、Sphinx関連のコマンドを実行する前に必ずset PYTHONPATH=と入力して、一時的に設定を解除してください。

PYTHONPATHは、そのPCの利用者が自分で設定する場合以外に、古いThinkpadやTracLightningなど一部のプログラムをインストールすると自動的に設定されることがあります。

Sphinx standalone installer

Includes for 1.4.1:

Python: 2.7.11
Sphinx: 1.4.1

Includes for 1.3.6:

Python: 2.7.11
Sphinx: 1.3.6

Includes for 1.2.3:

Python: 2.7.10

Sphinx: 1.2.3

sphinxjp.themecore = 0.2.0
sphinxjp.themes.bizstyle = 0.1.6
sphinxjp.themes.dotted = 0.1.2
sphinxjp.themes.htmlslide = 0.1.4
sphinxjp.themes.impressjs = 0.1.3
sphinxjp.themes.s6 = 0.3.0
sphinxjp.themes.sphinxjp = 0.3.1
sphinxjp.themes.trstyle = 0.1.1

sphinxcontrib-actdiag = 0.8.4
sphinxcontrib-blockdiag = 1.5.4
sphinxcontrib-nwdiag = 0.9.4
sphinxcontrib-seqdiag = 0.8.4

blockdiag = 1.5.3
blockdiagcontrib-class = 0.1.3
blockdiagcontrib-qb = 0.1.3
blockdiagcontrib-square = 0.1.3

actdiag = 0.5.4
nwdiag = 1.0.4
seqdiag = 0.9.5

docutils = 0.12
funcparserlib = 0.3.6
jinja2 = 2.8
markupsafe = 0.23
pillow = 3.0.0
pygments = 2.0.2
pypng = 0.0.18
webcolors = 1.5

setuptools = 7.0
gp.vcsdevelop = 2.2.3
zc.recipe.egg = 2.0.3
zc.buildout = 2.2.5

Release Note

  • 20160416
    • Sphinx-1.4.1 + Python-2.7.11, その他同梱パッケージを更新
    • Sphinx-1.3.6 + Python-2.7.11, その他同梱パッケージを更新
  • 20151109
    • Sphinx-1.3.1 + Python-2.7.10, その他同梱パッケージを更新
    • Sphinx-1.2.3 + Python-2.7.10, その他同梱パッケージを更新
  • 20141120
    • Sphinx-1.3b1版インストーラがSphinx-1.2.3をインストールしていた問題を修正
  • 20141115
    • Sphinx-1.2.3 + Python-2.7.8, その他同梱パッケージを更新
    • Sphinx-1.3b1 + Python-2.7.8, その他同梱パッケージを更新
  • 20141014
    • Sphinx-1.2.3 + Python-2.7.6, その他同梱パッケージを更新
    • Sphinx-1.3b1 + Python-2.7.6, その他同梱パッケージを更新
  • 20131210 (Sphinx-1.2 + Python-2.7)
    • Sphinx 1.2 に更新, その他同梱パッケージを更新
  • 20130818 (Sphinx-1.2b1 + Python-2.7)
    • 同梱したPython環境内にインストール済みのeasy_installが動作しない問題を修正。
  • 20130803 (Sphinx-1.2b1 + Python-2.7)
    • docutils-0.11, Python-2.7.5, setuptools-0.9.8 に更新
  • 20130715 (Sphinx-1.2b1 + Python-2.7)
    • Sphinx-1.2b1 (日本語Patchは本体に取り込み済み)
  • 20121026 (Sphinx-1.1.3 + 日本語patch + Python-2.7)
    • Based upon Sphinx-1.1.3 release
    • includePR#81(LaTeX日本語patchの新版)
    • includePR#61(日本語ファイル名patch)
    • include newer blockdiag at 2012/10/26
  • 20111025 (Sphinx-1.0.8 + 日本語patch + Python-2.7)
    • ベースをSphinx-1.0.8に変更
    • latexpdfja 時にgmakeコマンドからmakeコマンドを呼び出してしまう問題を修正
    • 同梱のblockdiag系を10/24時点の最新版に更新
  • 20110830 (Sphinx-1.0.7 + 日本語patch + Python-2.7)
    • Sphinx-1.0.7をベースに、以下のパッチが当ててあります
      • make にlatexpdfjaターゲットを追加、ただしgmakeやtexliveが必要(以前 Sphinx-users MLで話題になっていたpatchを追加しています)
      • 日本語ディレクトリ・ファイル名を扱えます
    • 同梱のblockdiag系が8/30時点の最新版です
    • PILではなくPillow(互換ライブラリ)の独自ビルド版を使っています
    • PYTHONPATHが設定された一部の環境でインストール出来ない問題に対応
  • 20110620 (Sphinx-1.0.7 + Python-2.7)
    • 20110618版でblockdiagで日本語が使用できない問題を修正
    • オフラインでインストールに時間がかかる問題を修正
  • 20110618
    • 最初のリリース

other releases