Windowsユーザの私がSphinxでハマった所

本日はSphinxハンズオンに参加させてもらう予定です。場合によってはキャンセルするかもしれませんが・・・
さて本当は、もっときちんとした形でWindowsユーザ用のインストール手順〜buildする所までを記事にしたかったのですが、どうしても時間が取れず。

Windowsを使っている事で私がハマったポイントをあげておきます。同じWindowsユーザの方の参考になりますように。

Pythonインストール時の注意事項

まずPythonをインストールする必要があるのですが、実は既にPythonがインストールされていたりしませんか？例えばTraclightningを使っていて、新たにPythonをインストールすると色々混乱します。
まずはコマンドプロンプトで

echo %path%

と打って、Python関連のパスが無いかどうか確認したほうがいいかもしれません。
既存のPythonがあるなら、それを使うか、新しくインストールするかを詳しい方に聞いてみて下さい。

rstファイル編集時

sphinx-quickstart

を打つと、基本的なファイル、ディレクトリが作成されます。その中に「index.rst」というファイルがあり、これは必ず編集する事になると思うのですが、生成された段階で文字コードがsjis(cp932)となっています。
文字コードをUTF-8に変更しないと、buildした時に文字化け、あるいはエラーが出てbuildできないという事になります。

• • • -

とりあえず上記2点を抑えておけば大丈夫な気がします。