问题标签 [epydoc]

我有一个包含多个类的 python 文件，并想使用 epydoc 从我的评论中创建一个文档。所以我在我的 Debian wheezy 系统上的控制台上做：

它始终执行 python 应用程序，文档生成停止在 21%。我使用 epydocgui 时的行为相同。

当我在一个简单的 hello world 程序上对其进行测试时，一切正常。该文件有> 1000行，所以我不能发布它。该程序本身运行良好。

有人知道为什么会这样吗？尽管还找不到任何格式，但格式错误是否会成为问题。

谢谢 4 帮助

我有一个 html 格式的在线手册，用于由 生成的 python 模块epydoc 3.0.1，并希望将其转换为pdf. 例如，epydoc它本身的文档以html和pdf的形式提供。有没有办法将格式维护的文档html转换为pdf格式？

（实际上，我只对手册的某些部分感兴趣，而不是全部感兴趣，如果我可以选择要添加到 pdf 中的 html 页面，那就太好了）。

如何使用 epydoc 记录函数中定义的实例变量。我使用了以下内容，但仅在生成的 html 文档的变量部分中__package__ = None显示。

这是在 EpyDoc 网站上指定的：

变量也可以使用注释文档字符串记录。如果变量赋值的前面有一个注释，其行以特殊标记“#:”开头，或者在同一行后面跟着这样的注释，那么它被视为该变量的文档字符串：

我尝试在 mac OSX10.10 上安装 epydoc。

我通过跑步做到了

从自述文件中指定的 epydoc 文件夹中。这似乎正确安装了文件奇怪的是，当我启动 python 并尝试

它没有找到 epydoc，但是当我输入 help() 而不是 epydoc 时，它确实可以工作，在我看来它已安装但我的 python 不知何故找不到它。

有谁知道我怎样才能让这个包运行

我有一个每晚的 epydoc 工作来生成文档，但我也希望它能够运行我的文档字符串测试。有谁知道让它自动对创建文档的每个文件运行文档字符串测试的方法？

我尝试将此代码插入到 epydoc 的主块中

但无济于事。它会在该块中查找 doctest，自然没有。我得到这个输出：

epydoc 和 Sphinx 文档生成器都允许编码器注释任何/所有函数参数的类型。

我的问题是：有没有一种方法（或模块）可以在文档字符串中记录时强制执行这些类型（在运行时）。这不是强类型（编译时检查），但（更有可能）可能被称为固定类型（运行时检查）。也许引发“ValueError”，或者甚至更好……引发“SemanticError”

理想情况下，已经存在类似于xkcdimport antigravity的“ ”模块的东西（如模块） ，并且这个“firm_type_check”模块已经存在于方便下载的地方。

仅供参考：epydoc 和 sphinz 的文档字符串如下：

epydoc： 函数和方法参数：

• @param p: ... # 函数或方法的参数 p 的描述。
• @type p: ... # 参数 p 的预期类型。
• @return: ... # 函数或方法的返回值。
• @rtype: ... # 函数或方法的返回值的类型。
• @keyword p: ... # 关键字参数 p 的描述。
• @raise e: ... # 对函数或方法引发异常 e 的情况的描述。

Sphinx：在 Python 对象描述指令中，具有这些字段的 reST 字段列表可以很好地识别和格式化：

• param、parameter、arg、argument、key、keyword：参数的描述。
• type：参数的类型。
• raises, raise, except, exception：引发特定异常（以及何时）。
• var、ivar、cvar：变量的描述。
• return，return：返回值的描述。
• rtype：返回类型。

我能找到的最接近的是 Guido 在mail.python.org中的提及，由 Jukka Lehtosalo 在Mypy Examples中创建。 CMIIW：mypy 不能作为 py3 模块导入。

本身不使用文档字符串的类似 stackoverflow 问题：

• 检查参数类型的 Pythonic 方法
• 在 python 中检查类型的规范方法是什么？

我正在尝试使用epydoc为复杂的 python API 生成 UML 图，但还没有成功。epydoc当我在某处读到它进行对象自省和源解析时，我正在使用它。

我将 mac 和 python2.7 用于我的目的，我可以epydoc从他们的 sourceforge 网站下载和安装。

我发现文档不足以让像我这样的人有任何帮助，而且我无法运行如下所述的命令

在我的终端上。有人可以帮我如何epydoc在 mac 上为 python API 生成 UML。

我怎样才能画出类似下面的东西，这是 epydoc 代码本身的 UML 图！

http://epydoc.sourceforge.net/api/epydoc.apidoc.VariableDoc-class.html

我正在寻找一个快速的图表工具/实用程序，它可以帮助我快速理解和反向工程其他程序员编写的 python 代码。

我有一个要记录的 python 包，我想隐藏一个正在导入的子包。

结构体：

shapefile 文件夹位于 restapi__init__.py和其他 .py 文件所在的目录中。如何通过命令行使用epydoc排除此问题？

到目前为止，我已经这样做了：

当我使用 epydoc GUI 并引用完全相同的文件时，我可以让它工作，但是当我从 cmd 执行它时，它正在添加文档shapefile，这只是一个依赖模块。我认为它包括 shapefile，因为它是从 open_restapi.py 文件导入的

在 epytext 中将变量类型指定为函数或实例方法的正确方法是什么？

我看过这个：

我也看到了这个：

我正在尝试使用 pdoc 生成文档，我的文档字符串如下所示：

我发现了这个问题：如何在使用 sphinx 生成 python 文档时保留换行符，但建议在每行前面加上 | 对我不起作用（它只是像这样出现）

在每行末尾使用 \n 的任何想法？