Download to read offline
Erlang and I and Sphinx.
- 1. Erlangと私とSphinx- Happy Lifewith Erlang and Sphinx-Tokyo Erlang Workshop #52010/08/27渋川よしき
- 2.
- 3.
- 4.
- 5.
- 6.
- 7.
- 8.
- 9.
- 10.
- 11.
- 12.
- 13.
- 14.
- 15.
- 16.
- 17.
- 18. Pythonのドキュメンテーションには手書きと自動作成と２種類あった。両方とも開発者、ユーザともにメリット、デメリットがある。手書きの方が品質は高いが、メンテナンスは苦痛であるWerkzeug0.2ではこの２つの組み合わせに挑戦した。Docutilsをベースにコードからの自動抽出を追加し、完全にコードとドキュメントの同期が取れるようになった。Georg Brandlはこのツールを書き直し、Sphinxとしてリリースした。これはPython 2.6,3.0のドキュメントでも使用され、Python以外のプロジェクトもサポートしているこれは今までで最高のドキュメントツールだ。自動相互リンク、索引の作成もサポートしている。拡張APIを使えばさらなる自動化も期待できるTwitterの写真を引用しました
- 19.
- 20.
- 21.
- 22. Sphinx 1.0から新機能Python、C以外のドキュメントも書けるように自分で対応言語を増やせるRubyのソースビルド結果 ..rb:module:: berrymq .. rb:function:: talk(識別子)メッセージを送りますクライアントとコネクションを張ったら :rb:func:`talk` が使えるようになりますberrymq.talk(識別子)メッセージを送りますクライアントとコネクションを張ったらtalk()が使えるようになります
- 23.
- 24.
- 25.
- 26.
- 27. 関数ディレクティブ関数名を引数に取るメソッドの省略、返値も記述できる引数、返値の説明は:param:, :type:, :return:,:rtype:フィールドを使う.. erl:function:: append(ListOfLists) -> ok :paramListOfLists: くっつけたいリストのリストここに箇条書きでもなんでも自由に文章書けます。
- 28.
- 29.
- 30.
- 31. マクロ、レコードロールarityがない以外は関数のロールとほぼ一緒です。他のロールもですが、 < >を使うと、ドキュメントに表示されるラベルを変えることもできます。:erl:macro:`APRILFOOL` は、エイプリルフールにコンパイルする時にのみ設定されるマクロです。:erl:func:`これ <lists:reverse/1>` を2回実行すると、時間コストはややかかります。
- 32.
- 33.
- 34.
- 35.
- 36.
- 37.
- 38.