从Python和C生成sphinx文档

Question

我有一个Python包，其中包含编译成.so的C代码。在我的Python代码中，我有docstrings。在我的C代码中，我也有文档字符串。 sphinx是否也对C源代码中给出的文档字符串敏感，以便我可以自动生成文档？

Answer 1

是的，假设你的意思是作为编译模块的一部分可用于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魔法会捡起它们。

如果你的意思是C语言中的文档字符串旁边的C函数，那么没有。您必须编写自己的代码来提取它们并将它们转换为rst文件。