Linux command
pydoc3 命令
文本
复制后可按需替换文件名、目录或参数。
常用示例
View module documentation
pydoc3 [module]
Search documentation
pydoc3 -k [keyword]
Start documentation server
pydoc3 -p [8080]
Write HTML documentation
pydoc3 -w [module]
View builtin function
pydoc3 [print]
说明
pydoc3 is the Python 3 documentation browser. It displays docstrings, module contents, and can generate HTML documentation or serve it via built-in web server.
参数
- -k _keyword_
- Search for keyword.
- -p _port_
- Start HTTP server.
- -b
- Open browser to server.
- -w _module_
- Write HTML file.
- -n _host_
- Server hostname.
FAQ
What is the pydoc3 command used for?
pydoc3 is the Python 3 documentation browser. It displays docstrings, module contents, and can generate HTML documentation or serve it via built-in web server.
How do I run a basic pydoc3 example?
Run `pydoc3 [module]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.
What does -k _keyword_ do in pydoc3?
Search for keyword.