2009年09月13日

Sphinxでライブラリリファレンスを書くための新機能?

http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains

Sphinxの開発者のGeorg Brandl氏が今日MLに投稿して明らかになった、新機能案。Sphinxはふつーの文書というよりは、ライブラリのリファレンスを書いたりする機能が充実していて、そちらで使われることを想定して開発されている(Pythonの標準ドキュメントで使われている)のですが、そこに大きく手が加わるかも、とのことです。今までは、関数の説明を書く時は、

.. function:: following(identifier)

   関数の説明

とやっていたのですが、py:functionなど、言語指定ができるようになるみたいです。今まではPythonの場合はfunction、C言語の場合はcfunctionみたいにそれぞれ別のディレクティブだったんですが、他の言語からも使われることを想定しての機能拡張みたいです。berryMQみたいに、いろんな言語のAPIを揃えようとしている場合にもうれしい変更です。はたして、rb:functionは追加されるのか?

ますます用途が広がっていきそうです。

posted by @shibukawa at 12:12 | Comment(225) | TrackBack(0) | Python はてなブックマーク - Sphinxでライブラリリファレンスを書くための新機能?
この記事へのトラックバックURL
http://blog.sakura.ne.jp/tb/32098940
※ブログオーナーが承認したトラックバックのみ表示されます。

この記事へのトラックバック
検索ボックス

Twitter

www.flickr.com
This is a Flickr badge showing public photos and videos from shibukawa.yoshiki. Make your own badge here.
<< 2017年05月 >>
  1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31      
最近の記事
カテゴリ
過去ログ
Powered by さくらのブログ