PYDOC3.15(1)

📦 version 3.15.0, in ubuntu stonking

💖 NAME 💖

pydoc3.15 — the Python documentation tool, bestie. it literally hands you docs for your Python stuff and it's giving main character energy ✨

🌸 SYNOPSIS 🌸

pydoc3.15 name

pydoc3.15 -k keyword

pydoc3.15 -p port

pydoc3.15 -g

pydoc3.15 -w module [...]

🦋 DESCRIPTION 🦋

pydoc3.15 name

okay so this one shows you text documentation on something. and name is flexible like that 💅 — it can be:

  • the name of a Python keyword
  • a topic
  • a function
  • a module
  • a package
  • or a dotted reference to a class or function within a module, or a module within a package

and if name contains a /, then bestie it gets used as the path to a Python source file to document. no cap.

also! if name is 'keywords', 'topics', or 'modules', you get a listing of those things displayed. iconic 🌈

pydoc3.15 -k keyword

this one searches for a keyword in the synopsis lines of all available modules. lowkey the best way to find stuff you half-remember 🍓

pydoc3.15 -p port

starts an HTTP server on the given port on the local machine. yes, your docs, but on the web, in your own house 🏠✨

pydoc3.15 -g

pops up a graphical interface for finding and serving documentation. it's giving cute little window energy 🎀

pydoc3.15 -w name [...]

writes out the HTML documentation for a module to a file in the current directory. and — plot twist — if name contains a /, it's treated as a filename; and if it names a directory, documentation is written for all the contents. obsessed 🔥

👑 AUTHOR 👑

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

okay bestie that's the whole page, periodt 💜 this was PYDOC3.15(1) from the General Commands Manual — go read your docs, you ate 💅🌸

📦 where this page comes from