Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Python documentation in Eclipse

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.

like image 598
kishkin Avatar asked Jan 09 '12 08:01

kishkin


2 Answers

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

Or download from Sourceforge

like image 63
alexeyhaidamaka Avatar answered Sep 28 '22 23:09

alexeyhaidamaka


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)  
like image 45
Mikko Ohtamaa Avatar answered Sep 28 '22 23:09

Mikko Ohtamaa