Reputation: 5106

How do I see the Python doc on Linux?

In Windows, Python has a chm type document, and it is very convenient to read. But in the Linux, is there any document let me to read?

Upvotes: 31

Answers (9)

Zaki

Reputation: 158

For python < 3.3 use the following command

pydoc -g
python -m pydoc -g

For python after 3.3

pydoc -b
python -m pydoc -b

Upvotes: 3

Zablon

Reputation: 157

I think the best alternative is to use DevDocs

plus it is offline
plus it has a desktop app as well

Upvotes: 3

liginity

Reputation: 321

System Ubuntu 18.04

To view offline documentation for Python,

install python3-doc with sudo apt install python3-doc . The documents are installed at /usr/share/doc/python3-doc/html
Open /usr/share/doc/python3-doc/html/index.html with a web browser.

The documents are just as presented on the official document site: https://docs.python.org/3/

Upvotes: 1

Martin Thoma

Reputation: 136379

Online documentation

The simplest way is to use Google to get to online documentation. There is no single point where you find all documentations of all modules. However, a few common ones are:

If you need offline documentation there are a few other possibilities:

Download it

You can download the documentation as HTML or a PDF: https://docs.python.org/3/download.html

When you have a web server running, you can use the HTML version and access it as you are used to via a browser. The HTML site looks just like you are used to. Even the search works offline, because it is implemented with JavaScript.

enter image description here

PyDoc

Some distributions like Debian offer a python-doc package. You can access it via pydoc -p [some port number] or via pydoc -g. This will create a local web server. Then you can open your browser and have a look at it:

enter image description here

Console: help(...)

The Python interactive console has a built-in help(...) system. You can either invoke it without an argument:

$ python
Python 2.7.5+ (default, Feb 27 2014, 19:37:08) 
[GCC 4.8.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> help()

Welcome to Python 2.7!  This is the online help utility.

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://docs.python.org/2.7/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, or topics, type "modules",
"keywords", or "topics".  Each module also comes with a one-line summary
of what it does; to list the modules whose summaries contain a given word
such as "spam", type "modules spam".

help>

or you can call it with a paramter about which you want to know something. That can be anything (a module, a class, a function, an object, ...). It looks like this:

>>> a = {'b':'c'}
>>> help(a)
Help on dict object:

class dict(object)
 |  dict() -> new empty dictionary
 |  dict(mapping) -> new dictionary initialized from a mapping object's
 |      (key, value) pairs
 |  dict(iterable) -> new dictionary initialized as if via:
 |      d = {}
 |      for k, v in iterable:
 |          d[k] = v
 |  dict(**kwargs) -> new dictionary initialized with the name=value pairs
 |      in the keyword argument list.  For example:  dict(one=1, two=2)
 |  
 |  Methods defined here:
 |  
 |  __cmp__(...)
 |      x.__cmp__(y) <==> cmp(x,y)
 |  
 |  __contains__(...)
 |      D.__contains__(k) -> True if D has a key k, else False
 |  
 |  __delitem__(...)
 |      x.__delitem__(y) <==> del x[y]
 |  
 |  __eq__(...)
 |      x.__eq__(y) <==> x==y
 |  
 |  __ge__(...)
 |      x.__ge__(y) <==> x>=y
 |  
 |  __getattribute__(...)
 |      x.__getattribute__('name') <==> x.name
 |  
 |  __getitem__(...)
 |      x.__getitem__(y) <==> x[y]
 |  
 |  __gt__(...)
: (scroll)

Upvotes: 22

Ray

Reputation: 1667

You can also install the Ipython to inspect the modules/objects in the interactive mode.
For example, you can do this in ipython:

import pygame  
pygame.draw.line?

then you get the result doc:

pygame.draw.line(Surface, color, start_pos, end_pos, width=1): return Rect
draw a straight line segment

In ipython you can use tab complition, it's helpful for inspecting something.

Upvotes: 5

wks

Reputation: 1148

If you use the Fedora distribution, then yum install python-docs. Other distributions may provide similar packages.

Upvotes: 6

ronakg

Reputation: 4212

Best way is to read the documentation built into Python shell.

$ python
Python 2.7.1 (r271:86832, Jul 31 2011, 19:30:53) 
[GCC 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2335.15.00)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> help()

Welcome to Python 2.7!  This is the online help utility.

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at http://docs.python.org/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules.  To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, or topics, type "modules",
"keywords", or "topics".  Each module also comes with a one-line summary
of what it does; to list the modules whose summaries contain a given word
such as "spam", type "modules spam".

help>

Upvotes: 4