PyDOC is a documentation tool for Python. It can be used both to access to the documentation of the modules that come with Python, and the documentation of third party modules.
In Windows, go to the icon "Module Docs" documentation of the standard library and "Python Manuals" to view the tutorial, referrals, and other more extensive documentation.
To use PyDOC in Linux:
pydoc ./modulo.py
To show the documentation of modulo.py
in the current directory.
In Linux, the documentation of libraries can be seen throught the browser by using:
pydoc -p 8000
At the address http://localhost:8000/. To run the graphical version of PyDOC type:
pydoc -g
PyDOC uses the module Doc Strings to generate the documentation.
Besides that, it is also possible to consult the documentation on the interpreter itself, with the function help()
.
Example:
In [1]:
help(list)
Which shows the Python list documentation.
In [1]:
Out[1]: