從Python和C生成sphinx文檔

Question

我有一個Python程序包，其中包含編譯成.so C代碼。 在我的Python代碼中，我有文檔字符串。 在我的C代碼中，我也有文檔字符串。 sphinx是否還會對C源代碼中提供的文檔字符串敏感，以便我可以自動生成文檔？

Answer 1

是的，假設您的意思是doc字符串可作為編譯模塊的一部分提供給python解釋器。 例如：

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注釋中指文檔字符串，則不會。 您將必須編寫自己的代碼以提取它們並將它們轉換為rst文件。