问题标签 [epydoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
895 浏览

windows-7 - 如何为win7运行epydoc gui?

epydoc 文档说: The graphical interface can be invoked with the epydocgui command, or with epydoc.pyw in the Scripts subdirectory of the Python installation directory under Windows.

我试过直接运行该文件,并epydoc.pyw从命令行调用它,即从我的python目录中的脚本目录调用它。>>> python epydoc.pyw>>> epydoc.pyw

我该怎么跑epydoc.pyw

0 投票
1 回答
45 浏览

python - Epydoc 符号的含义,L{ClassName} C{int}?

在阅读其他人的代码时,我遇到了这种类型的文档字符串@param reporter: A L{Reporter} instance, where ...,经过一番搜索后发现它是Epydoc。但是,这些符号(例如L{ClassName?}和)C{type?}是什么意思?

0 投票
1 回答
3016 浏览

python - PyCharm 和 reStructuredText (Sphinx) 文档弹出窗口

让我们想象一下,我想在PyCharm 4.5 社区版(也在 5.0 中尝试过)中看到一个简单方法的文档字符串弹出窗口。

我用epytext语法(自 2008 年以来不支持 Epydoc 生成器,仅适用于 Python2)和reStructuredText语法(由 Sphinx 使用 - 积极支持的生成器,用于官方 python 文档)写下了这些文档字符串

epytext 完美适用于 PyCharm 文档弹出窗口

PyCharm 与 epytext 配合使用

但是 reStructuredText 根本不显示任何参数!

PyCharm 失败并显示 reStructuredText 屏幕截图

尝试使用 PyCharm 设置来处理这个问题,阅读 PyCharm 有帮助,搜索 PyCharm bugtracker 并使用 Google 无法帮助我找到 PyCharm 中的这些文档字符串弹出窗口无法与社区推荐的文档字符串标记语言正常工作的原因。

这是因为功能需求低吗?也许,是否有一些有用的替代方法可以查看 PyCharm 甚至其他 IDE 中的现代文档标记?我还需要能够生成 HTML 格式漂亮的文档页。

我在这里找到了另一个主题,与同一问题有关,但自去年以来仍未得到答复。所以,我猜想在现代 IDE 中查看现代文档的愿望出了什么问题。

这是我的代码示例

0 投票
0 回答
152 浏览

python - 在 sphinx 中创建类概述,如 epydoc

早已停止开发的 Epydoc 过去常常提供对类或模块的极其强大的概述。例如,这个:

在此处输入图像描述

请注意,它使用文档字符串的第一行左右显示模块内的类。对于函数,它还显示函数原型以及文档字符串的开头和拼写出的可选参数。

这在浏览文档时非常有用,因为可以查看合理命名的类/模块并轻松找到合适的函数或方法。

我想在 Sphinx 中有这个类似的功能,但我找不到任何可以证明这一点的例子。坦率地说,我有点惊讶,因为在 Sphinx 的所有赞美之海中,似乎没有人关心这个功能是否缺席,或者至少据我所知是缺席。

有谁知道是否有办法复制像 Sphinx 中显示的图像这样的东西?

0 投票
0 回答
10 浏览

python-3.x - 文件之间的python3继承树

我有多个类的 python3 文件。我想知道是否有一个工具可以在所有python脚本中生成继承树?

我阅读了有关python 类继承树的信息,但它不起作用:

  1. 我创建了一个虚拟环境:

python3 -m venv tmp_python

source source tmp_python/bin/activate

  1. 然后我创建了两个文件:a.py:

和一个文件 b.py:

我想要一棵树:

我尝试使用但我有这个标准错误: