続・PHP のドキュメントを Sphinx で書いてみる (phpautodoc を作ってみた) #sphinxjp - Hack like a rolling stone
去年の12月にPHP のドキュメントを Sphinx で書いてみる (phpautodoc を作ってみた) #sphinxjpという記事を書きました。 その時に、PHP からドキュメントを抽出する phpautodoc というのを作ったのですが、 その後他の作業に夢中になっていたので自分でも使わないまま放置されていました。 ですが、最近ドキュメントを書く時間を作ったので、作りかけの phpautodoc に手を入れて使えるようにパッケージングしてみました。 tk.phpautodoc を使う phpautodoc は gist に貼りつけたままで自分でも使いづらかったので、 あらためて tk.phpautodoc という名前で公開することにしました。 本来であれば、sphinxcontrib-phpautodoc とかにすべきなんでしょうが、 実験的要素がまだ残っているのでちゃんとした名前
PHP のドキュメントを Sphinx で書いてみる (phpautodoc を作ってみた) #sphinxjp - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 26日目(相当)を勝手に書いたものです。 Sphinx の autodoc Sphinx には autodoc という機能があります。 未だにうまく使う方法を理解できていないのですが、ちゃんと使うと Python コードに書かれた docstring を元に Sphinx 文書にリファレンスを埋め込むことができるそうです。 Javadoc や Doxygen のようなことができるということですね。 「Sphinx 文書に埋め込む」というスタイルをとっているため、 コードに記述しづらいシステムの概要やミドルウェアの話、 運用における注意点などは通常どおり Sphinx 文書として記述して、 コードに関する説明などは docstring に書くという書き分けができそうです。 ただ、あまり詳しい説明が書いていないこともあり、 また Python
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
