PYDOC3.14(1)

🎀 pydoc3.14 — NAME 🎀

pydoc3.14 — bestie, it's the Python documentation tool ✨ she reads the docs so you don't have to 💅

🌸 SYNOPSIS 🌸

pydoc3.14 name

pydoc3.14 -k keyword

pydoc3.14 -p port

pydoc3.14 -g

pydoc3.14 -w module [...]

🦋 DESCRIPTION 🦋

• pydoc3.14 name — okay so this one shows you text documentation on something. and like, name is flexible fr fr: it can be the name of a Python keyword, a topic, a function, a module, or a package — or a dotted reference to a class or function inside a module, or a module inside a package. 👑

and get this: if name contains a /, it gets used as the path to a Python source file to document. and if name is 'keywords', 'topics', or 'modules', you get a whole listing of those things displayed. iconic behavior tbh 🫶

• pydoc3.14 -k keyword — searches for a keyword in the synopsis lines of all available modules 🔍 lowkey the fastest way to find where something lives.
• pydoc3.14 -p port — spins up an HTTP server on the given port, on the local machine 🖥️ your docs, but make it web.
• pydoc3.14 -g — pops up a graphical interface for finding and serving documentation ✨ yes ma'am, clicky-clicky docs 🎀
• pydoc3.14 -w name [...] — writes out the HTML documentation for a module to a file in the current directory 📝 and here's the nuance bestie: if name contains a /, it's treated as a filename; and if it names a directory, documentation is written for all the contents 💖

not me explaining all five modes in one breath 💀 but they're all so good, i fear.

💜 AUTHOR 💜

Moshe Zadka, based on "pydoc --help" 🌸 give them their flowers 💐

and that's the whole page bestie ✨ this came to you from the General Commands Manual as PYDOC3.14(1) — go read some docs, you deserve it 🫶💅🌈