2012-02-21 14 views
3

は、私は自動的に私の宣言ブースト-pythonのメソッドの参照を生成することができる方法のアイデア誰を持っている:ブースト-pythonの参照を生成

def("foo", foo, args("x", "y"), "foo's docstring") 
def("foo2", foo, args("x", "y"), "foo's docstring") 
def("foo3", foo, args("x", "y"), "foo's docstring") 
def("foo4", foo, args("x", "y"), "foo's docstring") 

答えて

4

あなたはsphinxを使用することができます。関数の引数リストをもっときれいにするには、それをちょっとハックする必要があります。 minieigenboost::python sourcesphinx config filegenerated docsについてはどうしたのですか?

同じ行にあるものの、より複雑なものについては、Yadeをご覧ください。

+0

ありがとうございます。やってみます。 –

0

事実上のPythonドキュメントジェネレータSphinxを使用します。 Sphinxを変更する必要はありません。

スフィンクスはdocstringsからドキュメントを抽出するので、Boost Pythonモジュールをドキュメント化するためにdocstringsを追加してください。いつものように共有オブジェクト(.soファイル)にコンパイルしてください。

モジュールごとに.rstファイルを作成します。例えば、モジュールdemo.fooためdemo.foo.rstを作成します。

.. automodule:: demo.foo 
    :members: 
    :undoc-members: 
    :show-inheritance: 

を次に、設定やスフィンクスを実行し、それがさまざまな形式であなたのための素敵なドキュメントを作成します。

関連する問題