3. Sphinxビルド環境の構築¶
3.1. Sphinx セットアップ¶
インストーラをダウンロードします。
https://bitbucket.org/sphinxjp/website/downloads/
SphinxInstaller_ja-1.1.3.20121026-py2.7-win32.zip をダウンロードします。
注意
最新バージョンでは正常にビルドされません。インストーラを起動しセットアップを行います。
コラム
インストール先として次のパスを指定します。例:C:\Sphinx環境変数PATHに追加されている事を確認します。
コラム
例:C:\Sphinx\bin
3.2. 動作確認¶
Sphinxソースをビルドします。
任意のディレクトリに配置したSphinxソースのプロジェクトに、コマンドプロンプトで開きます。
コマンドプロンプト上で、次のコマンドを入力します。make htmlビルドが完了すると、次のメッセージが表示されます、Build finished. The HTML pages are in build/html. ビルドが完了すると、Sphinxソースのプロジェクトディレクトリ直下に build/html ディレクトリが生成され、html版のドキュメントが確認できます。 build/htmlディレクトリ直下にある、 index.html ファイルを任意のブラウザで開きます。html版のドキュメントをブラウザ上で確認できます。