【Python】sphinxでAPIドキュメントを作る

みんなお仕事でAPIのドキュメント作るのってどうしてんだろう。WordとかExcelで作った事はあるんだけど、ちょいちょいレイアウト崩れたりしてムキーッてなる。wikiをHTMLにエクスポートして配布というのも長いこと続けてたけれど、リファレンス作るツールとして特化してるわけじゃないから痒いところに手が届かなかったり。

てな感じで悶々と過ごしてた明くる日、pythonのリファレンス眺めてたら右下になんか書いてあるのが目に入った。Sphinx…?通りかかる人に意地悪なクイズ出して、間違えたら食べちゃう怪異かな?なんかよくわからんけど凄そうだ(小並感)

といったところでsphinxについて調べてみると、色々な言語向けのドキュメントを作れるツールらしいゾ。これを使わない手は無いぜ。あ、ちなみに例のごとく会社のPCがWindows縛りなのでWindows環境で。

続きを読む 【Python】sphinxでAPIドキュメントを作る