Python documentation in Eclipse

Question

Is there a way to integrate standard Python documentation into Eclipse? So it will be possible to press F1 on an API function and get its description in the Help view of Eclipse.

I use PyDev.

Thanks.

alexeyhaidamaka · Accepted Answer · 2016-07-15T16:27:03.323

8

I've had the same problem, so I kinda made an Eclipse plugin for that purpose.

Or download from Sourceforge

edited Jul 15 '16 at 16:27

answered Jun 02 '12 at 09:01

alexeyhaidamaka

168
1
9

pydoc.tk is down. Would be nice if the Sourceforge page included an installation instruction. – ArtemGr Dec 06 '12 at 19:54
1

It does now. So this is just a docs.python.org browser, no context search? – ArtemGr Dec 08 '12 at 01:05
yes.not sure what context search you want, but the docs.python.org provides a search form at the left frame. – alexeyhaidamaka Dec 08 '12 at 07:51

score 5 · Answer 2 · answered Jan 09 '12 at 14:53

5

PyDev, nor Eclipse, does not provide integrated on-line help for the Python documentation. Unlike with Java, Python API source code documenting has several competing documentation standards and implementing support for them would be difficult.

However if the function under the cursor can be resolved its docstring is shown in a pop-up note.

http://www.python.org/dev/peps/pep-0257/

Also because Python is dynamic language, as opposite to static languages like Java, you rarely can resolve functions to their source in code development time.

Using Python console debugger you can use the help() command when the application is being run

  >>> help(obj.myfuction)

answered Jan 09 '12 at 14:53

Mikko Ohtamaa

82,057
50
264
435

Thank you for your answer! I know about help() and pop-up hint on a function and use them all the time. But for examples and more detailed documentation I go [here](http://docs.python.org). It's a pity that those docs could not be integrated (any way it will be relly hard to do) into IDE. – kishkin Jan 10 '12 at 09:07
1

I personally use duckduckgo.com as my browser search engine. If you type in query !python xxx it will search from Python docs. Also if you type in !pypi xxx it will search from Python package repositories. – Mikko Ohtamaa Jan 10 '12 at 09:32
Looked through [http://duckduckgo.com/tech.html](http://duckduckgo.com/tech.html). Many nice "!" things. Thanks! – kishkin Jan 10 '12 at 12:05

score 1 · Answer 3 · answered Jan 09 '12 at 14:14

1

None that I know of, but that would be very useful in pydev. You should suggest it in the eclipse pydev forum ,or code it yourself! If I was still a CS student I'd help..

answered Jan 09 '12 at 14:14

WeaselFox

7,220
8
44
75

I hope it will be there at some point. I'll go take a look at that forum now. :) – kishkin Jan 10 '12 at 09:09

score 0 · Answer 4 · answered Nov 28 '17 at 11:00

Zeal - https://zealdocs.org/

Although I do not see how to integrate it in Eclipse, it is pretty useful next to it on your desktop. And it is not only Python docs, but may more. A real life saving stuff this Zeal docs!

Just a footnote: I do not use Eclipse that much as I switched to PyCharm and Jupyther.

Python documentation in Eclipse

4 Answers4

Linked