PYDOC2.7(1)

📦 version 2.7.18, in ubuntu jammy

💖 PYDOC2.7 💖

okay bestie, gather round, because this is the manual page for pydoc2.7 — the Python documentation tool — straight outta the General Commands Manual section of the man pages. it's giving "your personal doc bestie who knows everything about Python and will absolutely tell you about it". let's get into it 🦋

✨ NAME ✨

pydoc2.7 — the Python documentation tool 💅

✨ SYNOPSIS ✨

pydoc2.7 name

pydoc2.7 -k keyword

pydoc2.7 -p port

pydoc2.7 -g

pydoc2.7 -w module [...]

✨ DESCRIPTION ✨

🌸 pydoc2.7 name

Show text documentation on something. not me being your personal encyclopedia fr fr 📚

so like, name can be literally any of these:

  • 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 inside a package 👑

and plot twist: if name contains a /, it gets used as the path to a Python source file to document. yes, a whole literal file path. iconic.

also, if name is keywords, topics, or modules, a listing of these things is displayed. so you get the whole menu instead of just one dish 🍓

🔍 pydoc2.7 -k keyword

Search for a keyword in the synopsis lines of all available modules.

like a little detective mission for one specific word across every module you've got. main character detective energy honestly 🕵️

🌐 pydoc2.7 -p port

Start an HTTP server on the given port on the local machine.

your docs, but on the internet (well, localhost, but still). serving looks 💅

🪟 pydoc2.7 -g

Pop up a graphical interface for finding and serving documentation.

pop-up window moment!! GUI girlies rise 🙈✨

📝 pydoc2.7 -w name [...]

Write out the HTML documentation for a module to a file in the current directory.

and the deets:

  • if name contains a /, it is treated as a filename
  • if it names a directory, documentation is written for all the contents

so you can export one thing, or export everything in a folder. bulk slay 🔥

✨ AUTHOR ✨

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

💀 no cap, that's the whole page. nothing hidden, nothing skipped.

and that's a wrap bestie!! this page is chillin' in the General Commands Manual, filed under pydoc2.7 — go document something cute, you've got this 🌈🎀💜

📦 where this page comes from