问题标签 [autodoc]

有什么方法可以排除模块的导入部分，然后用 sphinx-python 记录它？我有一个导入另一个包（其他不同项目）的模块，然后狮身人面像给出了这个错误：

""" 文件 "/usr/local/lib/python2.7/dist-packages/Sphinx-1.1.3-py2.7.egg/sphinx/ext/autodoc.py"，第 321 行，在 import_object import (self. modname) 文件“/home/x/GitHub/project/mod_example1.py”，第 33 行，在 from other_pck import Klass, KlassStuff ImportError: No module named other_pck """

如果我在调用/导入打包 sphinx 的模块中注释导入部分，则可以执行 autodoc。我尝试了所有 sphinx autodoc 模块：autoclass、automodule 等......但是一旦尝试导入另一个包，结果总是相同的。

谢谢

我从http://www.rbt.ca/autodoc/index.html下载了最新的 Postgresql Autodoc (v1.41)
当我运行 make 我得到这个错误：

问题是什么？

Mac OS X Lion，10.7.5
GNU Make 3.81

Hi I am writing some documentation for a Django project using sphinx.

My project (Django 1.4) looks like this:

I have sphinx setup in the conf.py:

So in my sphinx source files I can do this:

which works fine. However, these two examples do not work:

1.

2.

The second works if I move the fabfile into app1 and use app1.fabfile

I'm guessing I have some issue with my conf.py but I have tried many derivations but I cannot import my fabfile.py unless it is under an app dir (though under /funproject it doesn't work either).

Any help with this would be much appreciated.

当使用 sphinxautodoc扩展创建文档时，我如何记录一个类实例（而不是类本身），就好像它是一个函数一样？类__call__定义了一个方法。

我有一个使用 RPi.GPIO 模块的 Python 编写的 Raspberry Pi 项目。代码上的所有工作都是在不会安装 RPi.GPIO 的 Windows 机器上完成的，每次我尝试运行 autodoc 时它都会崩溃，说它无法导入 RPi.GPIO。

有什么办法吗？

我有一堆使用“特殊方法”的类：

现在我想为此使用 Sphinx 和 autodoc 生成 html 文档。我如何告诉 Sphinx 记录__contains__？我尝试添加

to conf.py，但这也包括__dict__我绝对不想要的。

目前，myproject.rst文件的相关部分如下所示：

编辑添加

确实添加了该方法的文档，但在一个单独的部分中——不作为Foo类文档的一部分。

我正在尝试使用 Swagger-PHP 生成 JSON 文件，以便我可以将它与 Swagger-UI 一起用于自动文档。

我尝试了链接：- https://github.com/zircote/swagger-php

我还尝试使用http://zircote.com/swagger-php/installation.html上的文档

但我的运气不好，我无法实现它。

我能够正确安装作曲家。Swagger-PHP 的捆绑包也已正确安装。

但问题是我无法使用/理解他们提供的测试示例。

因此，如果有人解决了它，请帮助！

提前致谢 ！！

我正在使用 rST/Sphinx 来记录我的 Python，但是在构建它时会抛出警告，例如

我的 Python 源文件记录如下：

rST 文件使用 autodoc 提供的automodule指令来提取所有文档字符串并记录所有成员。

上面的组合似乎工作得很好，但错误似乎暗示有一种正确的方法可以做到这一点。如果我从源文件顶部删除模块指令，错误就会消失，但是我无法在 Sphinx 获取的源中添加概要选项。

我目前正在为我的 Django 项目的文档评估 Sphinx。它由紧密耦合到一个项目中的多个应用程序组成。我想要完成的一件事是生成按类别分组的文档页面。我可以手动完成这一切，但我希望这可以自动化。

具体来说，除了常规生成的自动文档文档之外，我希望文档中的页面提供所有...

• 楷模
• 中间件
• 意见
• 上下文处理器
• 信号
• 测试用例

来自典型的应用程序结构，例如

和一个（据说）文档字符串

在文档中呈现，例如

意见

myapp. views.MyView

有关此视图的一些信息。

otherapp. views.OtherView

关于此 OtherView 的一些信息。

我看到django-sphinx-autodoc通常可能会对浏览应用程序有所帮​​助。我应该扩展/修改 django-sphinx-autodoc 来做我想做的事吗？你会建议一些其他的方法来得到这个吗？或者是手动完成这一切的唯一方法？

我有一个像这样的三层类结构：

我的index.rst文件如下所示：

Sphinx 为我生成了一个很好的 API 文档。它包括类Super和Sub，并带有适当的注释。它不包括Intermediate，因为它没有评论并且我没有提供undoc-members标志。这是因为我不想Intermediate出现在文档中。

我的问题是：因为我提供了show-inheritance标志，所以 Sphinx 会显示每个类的基础；object为Super和Intermediate为Sub。由于Intermediate没有记录，我不希望它出现在基类列表中。相反，我希望 Sphinx 在继承树中显示下一个记录的类，Super. 换句话说：我希望 Sphinx 显示Super，而不是Intermediate作为Sub.

有人知道怎么做这个吗？