PYDOC3.11(1)

💖 PYDOC3.11 💖

okay bestie, gather round, because this is the pydoc3.11 page from the General Commands Manual and it's literally the Python documentation tool. yes, THE one. she reads your code so you don't have to squint at it. no cap. 🎀

---

✨ NAME ✨

pydoc3.11 — the Python documentation tool

like, that's it. that's the whole job description. she documents. 💅

---

🌸 SYNOPSIS 🌸

pydoc3.11 name

pydoc3.11 -k keyword

pydoc3.11 -p port

pydoc3.11 -g

pydoc3.11 -w module [...]

five whole moods. pick your fighter. 🦋

---

🫶 DESCRIPTION 🫶

• pydoc3.11 name — show text documentation on something. and when I say something I mean name can be, like, a lot of things: the name of a Python keyword, a topic, a function, a module, or a package. OR it can be a dotted reference to a class or function within a module, or a module inside a package. very versatile, very demure. ✨

and here's the plot twist: if name contains a /, it gets used as the path to a Python source file to document. slay.

also, if name is 'keywords', 'topics', or 'modules', you get a listing of these things displayed. it's giving index. it's giving table of contents. 📚

• pydoc3.11 -k keyword — search for a keyword in the synopsis lines of all available modules. yes, ALL of them. she's thorough like that. 🔍
• pydoc3.11 -p port — start an HTTP server on the given port on the local machine. boom, your docs are now a website. main character energy fr fr. 🌐
• pydoc3.11 -g — pop up a graphical interface for finding and serving documentation. it's giving GUI. it's giving windows and buttons. adorable. 🖥️💖
• pydoc3.11 -w name [...] — write out the HTML documentation for a module to a file in the current directory. obsessed.

careful bestie, the / rule strikes again: if name contains a /, it's treated as a filename; and if it names a directory, documentation is written for all the contents. so like, know what you're pointing her at. 😭

---

👑 AUTHOR 👑

Moshe Zadka, based on "pydoc --help". iconic. legendary. we stan. 🌈

---

and that's the whole page, bestie — she signs off as PYDOC3.11(1), and that's from the Python 3.11 manual, so go document something gorgeous. periodt. 💜🧚