PythonとCからのスフィンクスのドキュメントを生成

Question

私は.soにコンパイルされたCコードを含むPythonパッケージを持っています。私のPythonコードでは、私はdocstringsを持っています。私のCコードでは、私もdocstringsを持っています。 sphinxもCのソースコードで提供されているdocstringsに敏感なので、私は自動的にドキュメントを生成できますか？

Answer 1

はい、コンパイル済みモジュールの一部としてPythonインタプリタで使用できるdocstringを意味するとします。たとえば、

static PyMethodDef methods[] = { 
    ... 
    {"convolve", 
    Pconvolve, 
    METH_VARARGS, 
    "convolve(xi,yi,x,dx,y): compute convolution of width dx[k] at points x[k],\nreturned in y[k]" 
    }, 
    ... 

    {0} 
} ; 

です。

通常のautodocの魔法がそれらを拾います。

doxygenのようなC関数の横にあるCコメントのdocstringを意味する場合は、いいえ。それらを抽出して最初のファイルに変換する独自のコードを記述する必要があります。