问题标签 [pydoc]
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.
python - Keyword-based documentation for CPython extensions
How CPython extensions should be written in order for pydoc to mention the arguments'name instead of (...)?
I've followed the official python tutorial about extending Python, and even for the keywdarg.parrot procedure I get:
whereas I would expect
django - Django 1.7，pydoc：AppRegistryNotReady 模型/应用程序尚未加载异常
我正在使用 django python 1.7 和 2.7。我有一个项目（'TEJUJAGUA'），里面有一个应用程序（'SIGAPPY'）。应用程序在使用时正确执行。我的问题是我需要使用pydoc生成文档。
为此，我从位于文件 manage.py 所在目录的 shell 中运行以下命令：
产生下一个输出：
导致pydoc只为某些文件生成 html 页面，但省略了 FirstView.py、forms.py 等其他文件。
关于为什么会出现此错误的任何想法？
如果您需要任何其他代码段，我会保持警惕。
python - pydoc中javadoc标签的等价物
在 javadoc 中，您可以使用诸如 , 之类的标签@author，@return这些标签@deprecated在制作 java 文档时会特别处理。pydoc 中是否有等效的功能，或者我是否仅限于方法文档字符串的逐字副本？
python - Python Docstring：这些 docstring 参数到底是什么意思？
有人可以告诉我以下文档字符串参数之间的区别吗？
:type而且:param
我已经看到两者都被用来指定方法参数的类型，但我认为它们的作用并不完全相同。其中一个用于程序员，另一个用于 IDE 或类似的东西？
:rtype,尤其是 :return:return和:returns
:returns 看起来很相似，那么分别在什么情况下使用呢？
python - 如何使用 pydoc 在 Python 文件中生成方法和属性列表
我有一些我写的类，其中一些我确实添加了一些文档字符串，比如在类标题中。
现在我想使用 pydoc 来生成文档，但我意识到 pydoc 不会打印任何东西，除非我真的在类中编写了 doc 部分，这不是我想要的。
有没有办法让 pydoc 生成所有属性、方法及其类型的列表，包括所需参数的类型（如果有）和返回的类型（如果有）？
如果我有这样的课程：
我想打印一些包含类名、类方法、数据类型的内容：
我相信 pydoc 不会那样做。还有其他方法吗？
我可以添加文档字符串以供稍后解释，但首先，我想打印出我的模块中的内容，以了解它需要什么，它返回什么等等。
python-3.x - 为什么 Python 3 中的 lib 不安装 DOS PATH？
我在 64 位 Windows 7 机器上安装了 Python 3.4。工作正常。我确实选择了将 Python 添加到 DOS PATH 环境变量的选项，这样我就可以在 DOS 命令行下工作，编写 python .py 并且无需键入完整的 Python 安装目录即可工作。
但是当我尝试使用pydoc时，我发现它不知道pydoc在哪里。为什么？因为只有 Python34 和 Python34\scripts 在 PATH 中。为什么不使用包含 pydoc.py 在内的各种有用工具的 Python34/lib？
python - 相当于 Perl 的“perldoc”的 Python 文档
快速perldoc概述：
在编写 Perl 模块时，您可以使用POD样式文档对其进行记录。然后，要了解模块的工作原理，您只需在命令行中输入：
perldoc <module_name>
我如何用 Python 做到这一点？
我知道 Python 有一种使用“docstrings”来记录代码的标准形式，这有点类似于 Perl 的 POD 风格。然后可以使用该help()函数提取有关 Python 模块的信息，但这远非优雅。
首先您需要启动 Python 解释器，然后导入您想要获取帮助的模块，最后您可以使用该help()函数获取有关该模块的信息。
例子：
有没有更好的办法？
我想要一个与 Perl 工作方式等效的 Python：
pydoc <module_name>
但是当我尝试这个时，我得到以下输出：
python - 在外部服务器中运行 pydocs - Python
我有一个项目，我想将它的文档放在外部服务器上。我知道我pydoc -p 5000会在http://localhost:5000/. 但是，我计划将该文档托管在 EC2 实例上，作为每个人都可以访问的外部服务器。假设机器的IP地址是10.10.10.10，它完全可以配置为外部访问。我如何必须pydoc在外部运行我的服务器？
python - 停止 pydoc 运行我的 Python 程序
在“ Windows 7 - 来自 cmd 的 pydoc ”之后，我遇到了以下问题。我准备了一个简单的文档字符串记录的 hello.py "hello world" 脚本：
并将其保存在 C:\Python34\lib 中。
然后使用 Window 的命令行，我将目录更改为 C:\Python34\lib，然后运行
我的输出是：
打印文档很棒，但首先它运行了程序。
如何让它不运行程序，只打印文档？
python - pydoc 可以用来生成联机帮助页吗？
我有一组要为其创建联机帮助页的 python 脚本。它们是用文档字符串记录的，所以我可以通过这种方式获取文档，但我也想要手册页。
有没有办法使用 pydoc 为联机帮助页生成 *roff 源？
编辑：类似于 perl 的 pod2man for python。