将文档添加到spyder（python IDE） [英] Adding documentation to spyder (python IDE)

问题描述

所以我最近一直在使用pygame库（在spyder中），但是我没有像内置的库那样安装文档。我已经环顾四周，但没有看到如何获取pygame文档或安装它。

So I've been working with the pygame library (in spyder) lately, but I don't have the documentation installed like the built-in library. I've looked around but haven't seen a how-to on getting the pygame documentation or installing it.

有没有pygame文档？如果是这样，我如何安装它，以便我每次忘记它不必google语法？如果您知道，请事先感谢！

Is there a pygame documentation? If so, how do I install it such that I don't have to google the syntax everytime I forget it? If you know, thanks in advance!

该文档是在您键入数学时显示选项的内容。或麻木。像 so 以及 so 当你使用不同的功能。

The documentation is something that shows the options when you type math. or numpy. like so as well as the syntax and brief explanation like so when you use different functions.

*请注意，我已经安装了pygame，它运行顺利（在专用的python解释器中执行）。

*Note that I have pygame installed, it runs smoothly (executing in a dedicated python interpreter as well).

推荐答案

（ Spyder dev here ）我想你试图从编辑器查阅文档，对吧？如果是这样，我必须让你知道，我们不可能提取所有 Python模块的文档，因为我们使用的库的一些技术限制。最有问题的模块是使用C扩展构建的模块，如（精确地）Pygame或OpenCV。

(Spyder dev here) I guess you are trying to consult the documentation from the Editor, right? If that's the case, I have to let you know that it's not possible for us to extract documentation for all Python modules, because of some technical limitations of the libraries we use to do it. The most problematic modules are the ones built with C extensions, like (precisely) Pygame or OpenCV.

我们知道这种情况，并在努力在将来解决它通过使用名为 jedi 的库，发布（在8月份发布的 2.3.1 的时刻计划）。

We are aware of this situation and are working to solve it in a future release (planned at the moment for 2.3.1, to be released in August) by using a library called jedi.

您还可以使用控制台（Python或IPython）获取文档。这是现在我们可以为您提供的最好的： - ）

You can also use the console (either Python or IPython) to obtain the docs. That's the best we can offer you for now :-)

这篇关于将文档添加到spyder（python IDE）的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！