从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文件。