问题标签 [epydoc]

我正在考虑将 epydoc 用于一个模块的文档。它看起来不错，并且在我生成 html 文档时工作正常。

我想尝试生成 pdf 格式的文档。我刚刚修改了配置文件中的“输出”设置。

不幸的是，epydoc 在生成 pdf 文件时失败。错误是“错误：读取 pstat 文件时出错：[Errno 2] 没有这样的文件或目录：'profile.out'”

它会生成一些 tex 文件。我想也许我错过了乳胶，但我对 tex 和乳胶不是很熟悉。更多的是我在 Windows 上工作。

制作 epydoc 生成 pdf 文件的下一步应该是什么？

在此先感谢您的帮助

当我加载我的代码epydoc并加载顶部模块时，它失败了：

它所指的是我试图在NoneType第 9 行加载的子模块。我怎样才能让 epydoc 解释为什么它无法在第 9 行加载模块，而不是仅仅向前推进并遇到错误？

按照诺斯科的要求。这是类似的示例，其中没有给出堆栈跟踪：

运行：

产生不太有用的：

我希望 epydoc 告诉我失败发生在bar.py. 我不希望它抱怨foo.py. bar.py我无法在一个小示例中重现我的具体问题，但我的基本要求是，当 epydoc 失败时，我希望它打印堆栈跟踪以指向问题。无论是加载子模块还是调用在字典中找不到键。

注意：这个问题的根源是我试图记录的代码是 SCons 的输入，它有不同的环境设置问题。这就是为什么当我在其中运行时epydoc它不起作用，但在运行时脚本仍然有效scons -f SConstruct.py。我也在尝试使用sphinx. 当我使用它运行时，sphinx它实际上显示了堆栈跟踪。也许我会和sphinx...

似乎有大量的 Python 文档工具。我遇到的另一个是 epydoc。似乎 Sphinx 是事实上的标准，因为它用于生成官方 Python 文档。有人可以帮我整理一下 Python 文档工具的当前状态吗？

我有一个包含多个全局函数和一个全局变量的模块。变量和一些函数遵循 Python 的“私有”命名约定，名称前导下划线。其他函数旨在公开，并且没有前导下划线。

我已经__all__在我的文件开头声明了我的公共函数名称列表。

当尝试使用epydoc为该模块生成文档时，epydoc将模块中的所有内容视为私有。而且，由于我使用的是--no-private标志，这意味着输出只显示模块本身的文档，而不是模块的元素或它们各自的文档。

如果我不将--no-private标志与 epydoc 一起使用，则所有内容都会记录在案。但我不想要那里的私人事物。这是踢球者：如果我注释掉我的__all__, epydoc 正确地记录了我的模块的公共元素。

我是一个相对的 Python 新手，但据我了解，这__all__是为了让您在导入其他模块然后其他模块导入您的模块时避免麻烦，并在所有技术上公开时试图对事情保持更严格的控制，只要您知道要访问的内容的名称。省略__all__会导致 Bad Things™，或者我被告知。同时，epydoc 声称它为__all__决定什么是公开的，什么不是公开的而感到荣幸。

是我错误地使用了 epydoc，错误地假设了__all__我的代码中的使用，还是 epydoc 中的错误？（我已经解决了 epydoc 中的一个错误处理错误，这显然是由较新版本的 docutils 引起的。）

我编写了一个依赖于配置文件的软件组件。为清楚起见，我想通过在相关类的文档字符串中添加示例文件来记录配置文件的结构。出于显而易见的原因，它应该以固定宽度的字体出现。

我知道的唯一方法是>>>在每一行之前添加，这很糟糕，因为 doctest 可能会认为这是一个 Python 代码段并失去理智。而且，它看起来真的很丑：

>>>[D b]

>>>端口 = 5432

>>>名称 = adam_db

...

我真正想要的是：

[D b]

端口=5432

名称=adam_db

...

在固定宽度的字体中。

有任何想法吗？

谢谢，

亚当

我将 reStructuredText 与 epydoc 一起使用。如何使内部链接的文本与链接的目标不同？我有：

Product 链接看起来很好，并链接到 Product 对象。Product.manufacturer 链接指向正确的成员变量，但不是 Product.manufacturer 的文本，我只想成为制造商。

我知道如果我使用 epytext 可以做到这一点，但我们想坚持使用 reStructuredText，以便我们以后可以根据需要切换文档生成器。

我有一个带有大量功能测试的 pylons 项目，我希望我的手动 QA 能够不时阅读，所以我使用 epydoc 在功能测试模块上构建 html pydocs。

它似乎工作正常。它生成文档，我可以浏览它们而没有任何明显的问题。

但是，当我运行 epydoc 构建时，我遇到了一个奇怪的错误，我不确定如何修复它：

p>

总共有 2 个包和 8 个模块正在发生这种情况。起初我想，可能是模块的头部或包的 __init__ 中没有文档字符串，但添加它们并不能解决问题。

这是专门为功能测试编写的 epydoc 配置文件的副本：

这是用于执行它的 shell 脚本的副本：

有什么建议么？

我正在为代码库生成一个 epydoc，并且有一些测试文件分散在各处，我不想包括在内。我可以使用--exclude生成选项并重命名文件，但我想知道是否有任何我可以添加到文件本身的内容，这些内容将被 epydoc 解释为不包含/解析该文件的命令。

我正在使用 reStructuredText 来记录我的代码，以便通过 epydoc 获得漂亮的离线 HTML 页面。

结果是辉煌的。唯一的缺点是，当我使用 Python 交互式 shell 时，help() 函数不会解析文档字符串中的 reST 元数据，而是按原样显示整个内容。

有没有办法让 help() 对文档字符串进行一些最小的解析？

我不希望渲染斜体字体或超链接，但至少要进行一些最小的清理以提高可读性。

在过去的 2 年中，我没有使用过 epydoc，但我发现只需很少的努力就可以很方便地跟踪我的类和方法。

今天我安装了最新版本3.0.1，但出现此错误，四处搜索似乎没有提供解决方案。

epydoc项目死了吗？