问题标签 [autodoc]

我需要使用 Sphinx 记录我的 Python 项目。但我不能使用autodoc.

当我配置我的项目时，我选择了“extension autodoc”选项，但现在如果我使用

我收到一个错误：

我配置了PYTHONPATH，现在好了。但是我已经有这个问题了。

我的索引文件是：

我需要有人告诉我如何解决这个问题。

谢谢

我正在尝试用 Sphinx 记录一个 Python 项目，但是我在将autodoc扩展名与namedtuple生成的类结合起来时遇到了麻烦。

在一份文件中gammatone.rst，我有：

在我的gammatone/coeffs.py，我有：

生成的代码namedtuple包含 Sphinxautodoc模块提取并包含的非常通用的文档字符串。我宁愿自己正确地记录课程，而不放弃autodoc模块的其余部分。

我试过在上课前放这样的东西：

...但它没有出现在生成的文档中。将它放在类之后会导致它嵌套在通用类文档下面，而不是替换它。

我如何简单地告诉 Sphinx（和autodoc扩展）使用我的ERBFilterCoeffs类文档而不是生成的类namedtuple？

假设我有这样的课程：

如果我使用带有autodoc扩展名的 Sphinx 来记录此类，如下所示：

...构造函数签名显示为MyClass(*args). 我宁愿覆盖它并将其记录为MyClass(first, second, third).

如果这是一个函数，我可以覆盖文档字符串第一行中的签名。但是这个技巧似乎不适用于类文档字符串。那么如何覆盖构造函数签名呢？

我正在尝试使用lein-autodoc，因为我相信它是 Clojure 的首选文档生成器。我已:dev-dependencies [[lein-autodoc "0.9.0"]]按照 lein-autodoc github 页面上的说明添加到我的项目定义中。

运行lein deps没有问题，但是lein autodoc失败，声称 autodoc 不是任务。

我怀疑问题是 lein-autodoc 设置为与 leiningen 1 一起使用。但是，我使用的是 leiningen 2。我应该用 autodoc 调用 lein 的另一种方法吗？或者 lein-autodoc 包没有设置为与 lein 2 一起使用？如果没有，是否有另一个首选的与 lein2 兼容的文档生成选项？

编辑：

在 Cubic 下面的提示之后，我创建~/.lein/profiles.clj如下：

现在，运行lein autodoc结果如下：

这表明 autodoc 可能与 Lein 2 不兼容？如果没有，是否有任何适用于 Lein 2 的文档系统？

我尝试使用 sphinx 和它的 autodoc 插件为包含数千个类的项目创建一个 html 文档。sphinx-apidoc创建了精彩的 rst 文件，但缺少自动创建autoclasses和automethods。

sphinx 中是否有一种方法/命令/实用程序可以在文档中自动包含所有变量、函数、类和装饰器？

一个 rst 文件的一些示例代码：

我正在使用带有扩展名的sphinxautodoc，并希望生成一个列表，该列表仅包含几个模块中未记录的成员函数，而不是记录的成员。

我可以成功地创建一个包含已记录成员和未记录成员的列表，如下所示：

正如预期的那样，单独使用该:members:指令仅创建记录成员的列表。

但是仅使用:undoc-members:指令（即省略:members:标志）根本不会产生任何列表：

有没有办法自动生成这个？

（主要文档包括一个显示所有已记录成员的页面，但我发现通过使用列出任何未记录成员的单个页面而不显示这些成员的文本来确保我为每个函数等编写文档会更有用记录在案的）。

我正在使用 Sphinxautodoc从源代码中的文档字符串生成 python 模块的文档。我知道我可以:synopsis:在automodule指令中包含 a ，但这违背了 using 的目的，autodoc即将所有文档放在文档字符串中。

所以我尝试向module文件中添加一个指令，如下所示：

但随后我收到关于重复模块的“严重”警告，因为我正在声明它并且autodoc也在声明它。此外，这样做也有点违背了使用的目的，autodoc因为我必须指定模块名称，而不是autodoc从文件名中找出它（没什么大不了的，但如果我决定更改模块，我也需要在这里更改它）。

我希望我可以为此使用类似于moduleauthor指令的东西，比如modulesynopsis或synopsis单独作为指令，但 Sphinx 似乎无法识别其中任何一个。

有谁知道使用时是否可以在文档字符串中包含概要autodoc？

假设我在 Python 模块中记录了一个变量，如下所示：

我可以在我的 .rst 文件中包含该单个变量的自动文档，而无需拖入模块__doc__字符串并为此生成文档输出吗？

我努力了

但两者都__doc__拖入字符串并且不显示some_random_name.

Is there a way to display a "Classes" list / tab using Sphinx, or to organize the html pages generated to show members by class, classes being visually well separated?

I use Sphinx 1.1.3, an try to document a Python extension (a custom one created with Cython). My problem is that the whole extension is displayed in one single block if I enter the modules tab (which is quite unreadable) and, by the other hand, the "Index" tab merges everything together (which is normal). I would like a per class display (something closer to what Doxygen would do).

Does something like:

exists?

Thanks a lot.

当我尝试为我导入的模块制作文档时，Sphinx 会引发此错误from google.appengine.ext import ndb：

我yaml通过将它包含在之前解决了同样的问题，sys.path但它不适用于gql. 我的conf.py配置是这样的：