sphinxの使い方
python関連のツールにsphinxというドキュメント作成ツールがある。
使い方についてメモ。まぁこのあたりを読めば大体書いているのだけども。
インストールはpythonのpipを使う。Windowsでしか試してないけど、LinuxやMacも変わらんはず。
sphinx-quickstartでプロジェクトを作成する。
sphinx-quickstartはpythonのインストールディレクトリのScript以下に置いてあるので、パスを通していない場合は、そこを参照。
先にプロジェクト格納用ディレクトリを作成しておき、そこでsphinx-quickstartを実行するのがよい。
実行すると、プロジェクトを置く場所root pathを聞かれるので、記述する。
そんな具合で、次々質問されるので、記述していく。
プロジェクト名とかVersionとか記述していく。大体デフォルトでいいはず。
conf.pyで概ね後からいじれるみたい。
出来上がると最低限のテンプレートとmakeが用意されている。
HTMLやらPDF、ePUB形式で出力できる。
ひとまずmake htmlを実行すると、rstファイルを元に、 _build\html\ にindex.htmlなどが作成される。
