PYDOC3.10(1)
β¨ NAME β¨
pydoc3.10 β the Python documentation tool ππ
okay so bestie, this is the manual page for pydoc3.10, and it lives in the General Commands Manual section. she's your little documentation bestie and she ate, no cap.
π SYNOPSIS π
pydoc3.10 name
pydoc3.10 -k keyword
pydoc3.10 -p port
pydoc3.10 -g
pydoc3.10 -w module [...]
π¦ DESCRIPTION π¦
pydoc3.10 name β the main character move π
Show text documentation on something. literally anything you're curious about.
- name can be the name of a Python keyword, topic, function, module, or package π«
- it can also be a dotted reference to a class or function within a module, or to a module inside a package (iykyk)
- if name contains a
/, then it's used as the path to a Python source file to document π - and if name is
keywords,topics, ormodules, then a listing of these things gets displayed instead π
pydoc3.10 -k keyword β the detective era π
Search for a keyword in the synopsis lines of all available modules. it's giving "where is that one thing" and honestly? slay.
pydoc3.10 -p port β server girl summer π
Start an HTTP server on the given port on the local machine. localhost core π«Ά
pydoc3.10 -g β the GUI moment π
Pop up a graphical interface for finding and serving documentation. yes bestie, we're clicking buttons now β¨
pydoc3.10 -w module [...] β the writer arc βοΈ
Write out the HTML documentation for a module to a file in the current directory.
- if name contains a
/, it's treated as a filename π - if it names a directory, documentation is written for all the contents ποΈ
π AUTHOR π
Moshe Zadka, based on pydoc --help π
and that's the whole vibe bestie π¦ no date on this one, just the pydoc3.10 page chillin' in the General Commands Manual β mwah, go read some docs π
π¦ where this page comes from
- ubuntu jammy: python3.10 3.10.12-1~22.04.18
- ubuntu jammy: python3.10 3.10.4-3
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms