← 返回命令列表

Linux command

pydoc3.4 命令

文本

复制后可按需替换文件名、目录或参数。

常用示例

View module documentation

pydoc3.4 [module]

Search for keyword

pydoc3.4 -k [keyword]

Start documentation HTTP server

pydoc3.4 -p [8080]

Write HTML documentation

pydoc3.4 -w [module]

View documentation for a class or function

pydoc3.4 [module.ClassName]

说明

pydoc3.4 is the Python 3.4 version of the pydoc documentation tool. It displays module documentation, searches installed packages, and can serve documentation via a local HTTP server, specifically for the Python 3.4 interpreter and its installed libraries. This version-specific binary exists on systems with multiple Python versions installed. For current development, use the latest pydoc3 instead. If name is 'keywords', 'topics', or 'modules', a listing of these categories is displayed.

参数

-k _KEYWORD_
Search for keyword in synopsis lines of all available modules.
-p _PORT_
Start HTTP documentation server on specified port. Use port 0 for an arbitrary unused port.
-b
Start HTTP server and open a web browser.
-w _name_
Write HTML documentation to a file in the current directory.

FAQ

What is the pydoc3.4 command used for?

pydoc3.4 is the Python 3.4 version of the pydoc documentation tool. It displays module documentation, searches installed packages, and can serve documentation via a local HTTP server, specifically for the Python 3.4 interpreter and its installed libraries. This version-specific binary exists on systems with multiple Python versions installed. For current development, use the latest pydoc3 instead. If name is 'keywords', 'topics', or 'modules', a listing of these categories is displayed.

How do I run a basic pydoc3.4 example?

Run `pydoc3.4 [module]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

What does -k _KEYWORD_ do in pydoc3.4?

Search for keyword in synopsis lines of all available modules.