PYDOC3.10(1)

πŸ“¦ version 3.10.12, in ubuntu jammy

✨ 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, or modules, 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