问题标签 [autodoc]

我正在使用Sphinx和autodoc 扩展为我的 Python 模块生成 API 文档。虽然我可以看到如何很好地记录特定参数，但我找不到如何记录**kwargs参数的示例。

有没有人有一个很好的例子来说明记录这些的清晰方法？

I am using Sphinx for documenting my python project. I have the autodoc extension enabled and have the following in my docs.

The problem is, it only documents the non-private methods in the class. How do I include the private methods too?

我已经安装了Sphinx来记录我正在处理的一些 Python 模块和类。虽然标记语言看起来很不错，但我还没有设法自动记录 Python 代码。

基本上，我有以下 Python 模块：

并在其中调用了一个类Seg。我想在生成的 Sphinx 文档中显示类和模块的文档字符串，并向其中添加更多格式化文本。

我的index.rst样子是这样的：

和chapter1.rst：

但是Seg只是以粗体打印，并且没有链接到该类的自动生成的文档。

尝试以下方法也无济于事：

编辑：将 SegLib 更改为段（感谢 iElectric！），并将 chapter1.rst 更改为：

尽管如此，不能让 Sphinx 直接记录类中的函数，或者更好地 - 自动将类中的所有函数添加到文档中。试过：

并得到：

任何想法如何使用简短命令自动记录函数和类？

Sphinx 有一个称为automethod从方法的文档字符串中提取文档并将其嵌入到文档中的功能。但它不仅嵌入了文档字符串，还嵌入了方法签名（名称+参数）。如何仅嵌入文档字符串（不包括方法签名）？

参考：http ://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

我正在尝试使用 Sphinx 在 Python 中记录一个超过 5,000 行的项目。它有大约 7 个基本模块。据我所知，为了使用 autodoc，我需要为项目中的每个文件编写如下代码：

这太乏味了，因为我有很多文件。如果我可以指定我想要记录“mods”包会容易得多。然后，Sphinx 可以递归地遍历包并为每个子模块创建一个页面。

有这样的功能吗？如果不是，我可以编写一个脚本来制作所有 .rst 文件，但这会占用大量时间。

我正在尝试使用 Sphinx 来记录我的 Python 类。我使用自动文档这样做：

虽然它正确地为我的方法获取文档字符串，但那些被装饰的：

与@checkStale存在

有一个不正确的原型，例如open(*args, **kwargs).

我怎样才能解决这个问题？我的印象是使用@wraps会解决这种事情。

我想使用sphinx 的 autodoc-skip-member事件来选择某个 python 类上的一部分成员进行文档。

但是从 sphinx 文档中并不清楚，我找不到任何示例来说明：我在哪里放置代码来连接它？我看到Sphinx.connect并且我怀疑它在我的 conf.py 中，但是当我在 conf.py 中尝试此代码的变体时，我找不到我应该连接（）的应用程序对象：

指向一个简单示例的指针将是理想的。

我正在尝试使用 Sphinx 为 python 项目自动生成文档。其中一个模块需要 scipy.signal 包，我尝试使用以下命令导入：import scipy.signal as signal。虽然代码运行得很好，但使用 Sphinx 制作 html 会导致分段错误（下面的输出）。但是，我可以使用“import scipy as sp”，确保将 scipy 目录放在我的 sys.path 中，并且生成的文档没有任何问题，但是当然，我的代码中将没有我的功能需要。

我做了一个非常简单的测试用例来演示这个问题，用几个文档字符串创建了一个测试类。我将它与我的 .rst 一起包含在下面。注释掉“import scipy.signal as signal”这一行，一切正常。

感谢您对如何在导入 scipy.signal 的同时避免段错误的任何见解。劳伦

狮身人面像输出：

pyexample.py

索引.rst

文档字符串.rst

我是使用狮身人面像的新手。它看起来很不错。我几乎已经使用 autodoc 记录了我的所有项目，但我想改变一种行为。阅读文档，我看到了这个：autodoc_member_order，并且想要更改为 'bysource' 值，关键是，我应该把这个值放在哪里？

谢谢，我为我糟糕的英语道歉。

更新：我正在使用狮身人面像 0.6.6

我正在使用 Sphinx 的 autodoc 插件来自动记录一组模块。我有一个接受 的函数，*args我想覆盖文档以显示funcname(arg1[, arg2[, ...]])Python stdlib 文档使用的稍微更好的样式。

是否可以覆盖特定功能的自动文档输出？