问题标签 [autodoc]

我将 Sphinx 与 autodoc 和 numpydoc 扩展一起使用来生成一个非常复杂的包的文档。我在自动生成中遇到了一个问题：

假设我有一个包含两个模块calculator.py和math.py.

在 内部calculator.py，我定义了一个类，它将math.py模块中的一个函数分配为标准变量：

在我的 sphinx 文档中，我使用类似于

在我的文档中，该函数现在显示为一个指针，而不是名称：

这是什么东西，我可以在 Sphinx 配置中进行更改，以便我的输出如下所示：

?

我正在尝试在扩展外部类的类上运行 autodoc。

我使用了模拟以便接受导入。

为此，我使用了此博客http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/中描述的内容

我尝试记录的 python 文件如下所示： from de.xyz import class_that_is_extended

运行 sphinx 后，结果是只显示类名和源链接。

当我将“类扩展类（class_that_is_extended）：”行更改为“类扩展类（对象）：”时，sphinx/autodoc 生成带有文档字符串的文档。

我怎样才能让课程保持原样并仍然在文档中获取文档字符串？

是否有一个自动文档指令可以列出给定类的所有子类？

如果我有以下 Python 代码：

有没有办法生成像这样的输出：

使用 Sphinx、Autodoc 和 Re-Structured 文本。（如 :show-inheritance: 但倒退）。就像是：

我正在尝试在我的项目中使用 Clojure 自动文档。我的 project.clj 看起来像这样：

当我这样做时，lein autodoc我收到此错误

我确实有二进制 sh

我该如何解决？

我正在从事一个涉及 Raspberry Pi 和 PiFace 接口模块的项目。该项目是用 Python 开发的，我在尝试使用 Sphinx 自动记录一些模块时遇到了问题。然而，我们正在使用该pifacedigitalio库，即使我已经在开发机器上安装了该库，Sphinx 拒绝记录该模块并抱怨由于不存在硬件而引发异常。硬件不存在，因为这是开发机器。为了测试软件，我们只使用条件if hwpresent then skip，但我实际上想通过 Sphinx 记录这些部分。做的时候产生的错误make html是：

有没有办法避免 Sphinx 解释代码而只解析源代码？我尝试pifacedigitalio/core.py使用虚拟返回手动修改，但 Sphinx 只是冻结了。

我正在为我的 Python 包编写文档，并且我正在使用 sphinx 和 autodoc 扩展。我想要两个版本的文档：用户文档和开发者文档。这两者之间的重叠非常大，所以我基于一个来源生成它们。通过 ifconfig 扩展包含仅针对一个输出的部分。

现在我想要两个版本的 API 规范，一个是用户的基本版本，一个是开发人员的详细版本：

一般来说，它工作正常，但有一个问题。在第二个指令生成的文档中（在本例中：用户文档）有类及其方法的条目，但它们没有与之关联的 HTML 锚点。在文档的其他部分，链接Settings是活动的，但它们无处可去（点击时没有任何反应）。

如果我将订单切换为：

开发人员文档中的锚点仅适用于私人和特殊成员。所以看起来第一个 ifconfig “保留”了它的所有方法，当它们在第二个 ifconfig 中重复时，会发生一些不好的事情并且没有生成锚。

我想这是一个错误而不是一个功能:) 无论如何，有人知道如何修复它吗？

有没有办法用 Sphinx 的 autodoc 插件记录嵌套类？

在：

我想在我的文件中使用autoclass或类似的东西来专门记录。.rstA.B

我试过了：

和

没有成功：

当然A不是模块；似乎autoclass正在考虑最后一个之前的任何东西.作为包和模块。

我正在使用 sphinx-apidoc 和 autosummary 扩展来记录库的 API，但我真的无法理解以下generated/选项的目的：

我已经看到这是 Sphinx 文档，在 pandas 等库中。我正在使用toctree并且我的 API 正在自动生成，但我不明白生成的是什么。我没有看到一个名为 generate 的文件夹，也不知道这样做的好处/目的是什么。

谢谢

您可以像这样在 Python 文档字符串中指定参数类型：

使用 Sphinx 的 autodoc 功能，这会产生参数列表，并且每个参数都用它们的类型正确标记。

但是如何使用实例属性来做到这一点？像这样的东西

不起作用。可以在 the 后面放一个单词类型，:ivar但是这里它由三个单词组成，这样就行不通了。

当尝试构建文档（任何类型：html、手册页、latexpdf...）时，sphinx 在尝试自动文档化项目的子目录时失败。我尝试了许多不同的方法来试图缩小问题的范围，但我似乎找不到罪魁祸首。所有 rst 文件都是由 sphinx-apidoc 生成的。

目录 A 具有以下 rst 文件：

如果 :members: 指令被删除，则不会发生故障。如果文件 B 或 E 丢失，或者文件 B 在 E 中的导入丢失或被注释掉，也不会发生故障。

如果 fileB 和 fileE 配对到以下内容，它仍然会失败：

文件B：

文件E：

使用以下堆栈跟踪：

autodoc 试图读取的文件是否有问题，或者它们是否是 autodoc 本身的问题？我可以尝试一些解决方法吗？

谢谢！