STANNIX Community


Manual: pydoc3

PYDOC3.14(1)					   General Commands Manual					PYDOC3.14(1)

NAME
       pydoc3.14 - the Python documentation tool

SYNOPSIS
       pydoc3.14 name

       pydoc3.14 -k keyword

       pydoc3.14 -p port

       pydoc3.14 -g

       pydoc3.14 -w module [...]

DESCRIPTION
       pydoc3.14 name Show text documentation on something.  name may be the name of a Python keyword, topic, function, mod‐
       ule,  or	 package, or a dotted reference to a class or function within a module or module in a package.	If name con‐
       tains a '/', it is used as the path to a Python source file to document. If name is 'keywords',	'topics',  or  'mod‐
       ules', a listing of these things is displayed.

       pydoc3.14 -k keyword Search for a keyword in the synopsis lines of all available modules.

       pydoc3.14 -p port Start an HTTP server on the given port on the local machine.

       pydoc3.14 -g Pop up a graphical interface for finding and serving documentation.

       pydoc3.14  -w  name [...]  Write out the HTML documentation for a module to a file in the current directory.  If name
       contains a '/', it is treated as a filename; if it names a directory, documentation is written for all the contents.

AUTHOR
       Moshe Zadka, based on "pydoc --help"

														PYDOC3.14(1)