Sphinx で自動的にAPIリファレンスを作成したい - Study08.net 対シンバシ殲滅用人型機動兵器

今日はこのネタです。タイトルの通りなんですが、PythonでそもそもAPIリファレンス的なドキュメントをどうやって作ったら良いのか知りませんでした。 他の言語であれば下記のようなツールを過去に使った事がありました。 Java なら Javadoc Perl なら pod2html PHP なら PHPDocumentor (今ならもっと賢いツールありそうだけど。。。) Pythonなら? ではPythonであればどのような選択肢があるでしょう。調べた限りではまず下記のような選択肢がありました。 pydoc -w でHTML生成 (pydocで簡単なPythonファイルのドキュメントを作成する) Epydocを利用する (Epydoc - 偏った言語信者の垂れ流し) javadocやらphpdocmentorやらのように、まるっとソースからHTMLを生成するだけであれば、これで十分かもしれま

[hoxo_m]

sphinx-apidoc めっちゃ便利やん。

[toromoti]

まじか

[kutakutatriangle]

こうやって書けるんだ。