phpMan > man > PYDOC3.10(1)

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



NAME
       pydoc3.10 - the Python documentation tool

SYNOPSIS
       pydoc3.10 name

       pydoc3.10 -k keyword

       pydoc3.10 -p port

       pydoc3.10 -g

       pydoc3.10 -w module [...]

DESCRIPTION
       pydoc3.10  name  Show text documentation on something.  name may be the name of a Python key‐
       word, topic, function, module, or package, or a dotted  reference  to  a  class  or  function
       within  a module or module in a package.  If name contains a '/', it is used as the path to a
       Python source file to document. If name is 'keywords', 'topics', or 'modules', a  listing  of
       these things is displayed.

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

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

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

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

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



                                                                                        PYDOC3.10(1)