问题标签 [epydoc]

我的班级中有一些方法仅供班级的其他方法使用。我在他们的名字前加上'_'。我可以从 epydoc 中隐藏这些功能吗？这是个好主意吗？

我应该使用'_'还是双下划线？老实说，在某些地方阅读了它们之后，我并没有得到区别。此命名约定是否应该仅用于模块/类（实例）函数？还是变量？

我有一个使用 epydoc 记录的项目。现在我正在尝试切换到狮身人面像。我为 epydocs 格式化了所有文档字符串，使用 B{}、L{} 等进行粗体、链接等，并使用@param、@return、@raise 等来解释输入、输出、异常等。

所以现在我切换到狮身人面像它失去了所有这些功能。是否有一种自动方法可以将 epydocs 格式的文档字符串转换为 sphinx 格式的文档字符串？

即使在应用补丁之后，Epydoc 也无法正常工作，所以我正在尝试迁移到 Sphinx。

我想从一个简单的 python 文件自动生成文档：test.py

安装并运行sphinx-quickstart-script后，我​​将test.py复制到源文件夹并输入：

sphinx-build -b html .\source .\build

但它只生成最小的 html 文件，它不解析test.py文件

我没有主意了。

谢谢你的帮助 ：）

Epydoc 文档说您可以通过该dotgraph指令在源代码中包含 Graphviz 图。

但是，如果尝试这个：

我得到的只是一个错误说法Unknown directive type "dotgraph"。我使用最新的epydoc（v3.0.1）并dot在我的系统中正确安装。

我怎样才能epydoc制作图表？

我将如何从构建的scons创建运行epydoc或/和pylint的构建器？

我想要一个docs为我的包运行 epydoc 的目标（比如）。我假设我需要创建一个新命令，但我运气不佳。

有没有人这样做过？

我不是我所缺少的，而是以下代码：

生成文档时出现以下 epydoc 错误：

当我将@abstractproperty装饰器更改为装饰器时，警告消失@property。所以我的问题是这是一个错误还是我错过了什么？

使用 epydoc，版本 3.0.1。

我尝试了这个简单的事情：

跑这个：

但是在 epydoc 生成的 html 中，方法原型仍然以 3 个连续的点出现，而不是描述的参数：

任何的想法 ？非常感谢

编辑：对不起，我刚刚测试了一个可以完美运行的简单脚本。前一种情况不起作用，因为它是使用 Cython 编译的共享对象 (.so)。它有所作为。源也无法显示。我认为 epydoc 只在文档字符串上工作，关于函数原型的解析，但它似乎比这更复杂一些......

EDIT2：此外，如果我编译将“embedsignature” cython 编译指令传递给“True”，我会得到一些东西 - 这仍然是错误的，但我更好地理解了这种现象：

又名：epydoc 不理解 cythonized 签名的嵌入方式......

如果你有更具体的解释，我仍然是你的男人。谢谢

一切都在问题中：我将如何更改 epydoc 生成的 html 页面 favicon ？

注意：我看到了如何自定义 css 内容，但没有关于自定义输出 html 文件...

非常感谢。

我正在为 python 中的方法编写文档，这些文档应该可供最终用户阅读。我正在使用 Epydoc 字段标签根据给我的要求记录参数，并尝试将参数描述放在方法描述和使用该方法的示例之间：

不幸的是，我没有成功找到从类型标签中排除示例的方法，它们被添加到其中而不是分开。我试图不将参数移动到参数的末尾，因为我们觉得这看起来更整洁；有什么方法可以终止文档标签并从中排除任何以下文本？