プログラムを中心とした個人的なメモ用のブログです。 タイトルは迷走中。
内容の保証はできませんのであしからずご了承ください。

2016/06/10

Sphinxのインストール

event_note

SphinxとはPython製のドキュメント作成ツールです。
reStructuredTextという軽量マークアップ言語で記述し、HTMLやPDFに出力できます。

インストール

通常の方法だと、Sphinxの前にPythonをインストールし、環境変数の設定などを行うなどの準備が必要なので面倒です。
しかし、Windowsの場合はそれを全て一つにパッケージしたインストーラーがあるので、それを使用すると楽です。
インストーラーは以下のページからダウンロードできます。

インストール自体はウィザードに従って行うだけなので、特に問題ないと思います。

環境変数の設定

システム環境変数 Path に以下2つを設定します。

C:\Program Files\Sphinx\python;
C:\Program Files\Sphinx\python\Scripts;

動作確認

以下を実行してそれっぽく動いたらsphinxはインストールOKです。

sphinx-quickstart

pythonの環境変数が正しく設定されているか確認するため以下を実行します。
それっぽく動いたらOKです。

python

python拡張用のコマンドpipが動くかも確認します。
それっぽく動いたらOKです。

pip