epydoc

1热度

1回答

当我我的代码加载到epydoc和公正加载失败，顶部模块： Error: TypeError: 'NoneType' object is not callable (line 10) 当它是指NoneType的是，我试图在线9加载哪有我一个子模块得到epydoc解释为什么它不能加载第9行的模块，而不是仅仅前进，并发生错误？根据nosko的要求。下面是类似的例子，在没有堆栈跟踪给定： # foo

1热度

1回答

epydoc：固定宽度文本的块

我写了一个依赖于配置文件的软件组件。为了清楚起见，我想通过在相关类的docstring中添加示例文件来记录配置文件的结构。出于显而易见的原因，它应该以固定宽度的字体出现。我知道的唯一方法是在每行之前加上>>>，这是不好的，因为doctest可能认为这是一个Python代码段并失去了智慧。此外，它看起来非常难看： >>> [DB] >>>端口= 5432 >>>名= adam_db ... 我真正

1热度

1回答

如何使用epydoc生成pdf？

我正在考虑epydoc的一个模块的文档。它看起来对我很好，并且在生成html文档时工作正常。我想尝试生成pdf格式的文档。我刚刚修改了我的配置文件中的'输出'设置。不幸的是，epydoc在生成PDF文件时失败。错误是“错误：错误读取pstat文件：[Errno 2]没有这样的文件或目录：'profile.out'” 它生成一些tex文件。我认为也许我缺少乳胶，但我并不是非常熟悉tex和乳胶。更

1热度

1回答

使用epydoc记录公共全局函数

我有一个包含多个全局函数和一个全局变量的模块。这个变量和一些函数遵循Python的'私人'命名约定，并且带有前导下划线。其他功能旨在公开，并且没有领先的下划线。我已经在我的文件开头声明了__all__，列出了我的公共函数名称。当试图使用epydoc生成此模块的文档时，epydoc正在考虑模块中的所有内容都是私有的。而且，由于我使用的是--no-private标志，这意味着输出仅显示模块本身的文

27热度

2回答

如何记录Python代码：Epydoc，doxygen，Sphinx，...？

我不确定我是否应该使用Epydoc或doxygen来记录我的Python代码。目前我更喜欢Epydoc，因为它专门用于Python，它的语法与doxygen（我用于记录我的C/C++代码到目前为止）没有太大差别。针对Epydoc或使用doxygen的任何参数？ http://epydoc.sourceforge.net/ http://www.doxygen.org/ http://sphinx

0热度

1回答

epydoc和reStructuredText更改链接名称

我正在使用epydoc的reStructuredText。我如何让内部链接的文本与链接的目标不同？我有： :todo: Figure out the `Product.manufacturer` relationship in `Product`. 产品链接看起来不错，并链接到产品对象。 Product.manufacturer链接转到正确的成员变量，而不是文本是Product.manufac