我有一个开源包，其中包含许多不同子模块上的类。所有类都有方法fit和transform，并fit_transform从 sklearn 继承。所有类都有跟随 numpydoc 的文档字符串，带有子标题参数、属性、注释、另见和方法，我在其中列出fit和. 我复制一个类的例子：transformfit_transform

在 Sphinx 的 conf.py 中，我包括：

当我使用 构建文档 sphinx-build -b html docs build时，文档构建得非常好，但是每个类我收到 3 个警告，每个方法一个，上面写着：

我已经用尽了我所有的搜索资源，我准备放弃了。有人知道如何防止该警告或如何使狮身人面像不将其打印到控制台吗？

我附上了错误的副本，如果需要，我可以提供指向 repo 的 PR 链接

我有一个项目，其中一些功能以拿破仑 numpy 风格记录。本着 numpyness 的精神，我有一堆属于 class 的函数参数array-like。这是一个例子：

这工作得很好，并且类型包含在没有链接的输出中：

问题是我在每个函数的每一行都收到警告：

我相当确信有一些解决方案。似乎PR #7690以某种方式解决了这个问题，但我在拿破仑或更广泛的 sphinx 文档中的任何地方都找不到有意义的参考“预处理”。

那么如何摆脱警告呢？

我收到多个警告，例如：

警告：pyfar.signal.TimeData.times 的重复对象描述，pyfar.classes_audio 中的其他实例，使用：noindex：其中之一

但不知道为什么？有人建议我可能在不同的 rst 文件中包含两次相同的对象。但我认为情况并非如此。

我尝试基于原始包（https://github.com/pyfar/pyfar/tree/develop/docs）创建一个最小的工作示例：

获取代码

制作虚拟环境

构建文档

产量

感谢您的任何回复，法比安

Intersphinx 是一个非常好的工具，可以将交叉引用放入包文档中。然而，一个问题是，这些交叉引用的编写方式会导致在help(function)终端或function?jupyter-notebook 中阅读时文档字符串的易读性降低。

考虑以下示例：

请注意，由于有类型别名，参数和返回类型实际上不需要:class:`~pandas.前缀：

是否有一种简单的方法可以为文档字符串的函数描述部分实现相同的功能？理想情况下，我希望有一种方法可以定义一个宏，以尽可能减少文档字符串中的噪音（=非内容字符）。如果可以定义宏/交叉引用，以便我们可以编写Series_或:Series:或类似的东西来代替:class:`~pandas.Series` 并获得相同的格式，那将是一个巨大的改进。

我一直在阅读本指南，以编写带有 numpy ndarrays 类型提示的 Google 风格和 Numpy 风格的文档字符串。在 Numpy 样式的文档字符串示例中，类型提示缩写为“np.ndarray”。但是，在相应的 Google 样式示例中，类型写为“numpy.ndarray”。

是否可以将“np.ndarray”用作 Google 样式的文档字符串中的一种类型，或者必须完整地写出“numpy.ndarray”？

我还没有找到任何其他在 Google 样式的文档字符串中使用的 numpy 类型的示例，但我确实看到了一个完整写出“pandas.dataframe”的示例。

如果可以同时使用两者，根据 Google 风格的指南，哪个是正确的？

我在 sphinx 中使用拿破仑扩展来生成自动文档。

另外，我不确定是否在上面的正确上下文中使用“类型提示”。python 文档字符串中的类型规范称为“类型提示”，还是仅用于 python 语言本身的实际类型提示的名称？

我想使用乳胶 algpseudocode 包将算法添加到我的文档字符串中。我还希望能够定义用户宏来加快我在文档字符串中输入数学方程式的速度。

我正在使用带有 sphinx 的拿破仑自动文档样式从我的文档字符串中生成文档。

我正在使用 Sphinx 自动文档和拿破仑扩展来为我的项目 ( Qtools ) 生成文档。这在我的本地机器上运行良好。我正在使用 Sphinx 3.1.2（或更高版本）。但是，当我在 Read the Docs (RTD) 上构建文档时，只会处理直接添加到构成文档源的 reStructuredText 文件的文本。应该由 autodoc 提取的文档字符串不会出现在RTD 生成的 HTML 文档中。所以例如在docs\source\section2_rsdoc.rst我有：

这导致：

反应谱

反应谱类

响应谱创建

另见qtools.convert2rs（将功率谱转换为响应谱）。

换句话说，所有指令显然都被忽略了，并且没有添加到其他函数的超链接。我已经检查了几个基本的指导文件，比如这个，但我不知道我做错了什么。RTD 构建文档时没有任何错误或警告。在 RTD 高级设置中，我有：

• 文档类型：Sphinx HTML
• 需求文件：requirements.txt
• Python 解释器：CPython 3.x
• 安装项目：否
• 使用系统包：否
• Python配置文件：空白
• 启用 PDF 构建：否
• 启用 EPUB 构建：否

我没有触及任何其他设置。

在conf.py我尝试了第 15 行的以下变体：sys.path.insert(0, os.path.abspath('.'))和sys.path.insert(0, os.path.abspath('../..'))当前的sys.path.insert(0, os.path.abspath('../../..')). 这些都没有任何区别。

如果有任何帮助，我将不胜感激！

对于模块级函数，有没有办法自动生成经常出现的内容，即 'Returns: None' ，这样就不会在许多文档字符串中重复写入？

我已经看到了一些使用 的格式napoleon_custom_sections，但这似乎不是我的直接用例。

例如，如果以下生成的文档包含 None Return 或对基本文档字符串的其他指定添加：

正如这篇文章所描述的，即使拿破仑将字段作为文档添加到以下位置，autodoc 也会急切地将类变量添加到文档中：

我想明确告诉 autodoc 不要记录任何类变量（在数据类的情况下也是实例变量） - 我只希望 autodoc 显示给定类的声明函数，并让拿破仑处理它的所有类的类/实例变量发现. 如果没有:exclude-members:每个班级，这可能吗（这是一个巨大的麻烦）？

我已经尝试过：

在我的conf.py和这个.rst文件中：

这应该隐藏无证成员，但他们仍然出现：

所以我已经在一些文档上工作了几个星期了，直到昨晚所有的变量都开始出现在格式中，它们总是看起来很好~Class.Attribute。我试图回滚到多个以前工作的版本，但它们都显示像这样的变量。我是否缺少一些东西来让这些只显示没有~Class..