PDOC:(1)

💖 PDOC:(1) 💖

User Commands ✨ so like, this is the manual page for pdoc:, bestie. Buckle up.

---

🌸 NAME 🌸

pdoc: — generate Python API documentation. yes that's it. that's the whole job. and it ATE. 💅

---

✨ DESCRIPTION ✨

okay so here's the vibe. the usage goes a little something like this:

usage: pdoc [-o DIR] [-d {markdown,google,numpy,restructuredtext}]
       [--include-undocumented | --no-include-undocumented] [-e
       module=url] [--favicon URL] [--footer-text TEXT] [--logo URL]
       [--logo-link URL] [--math | --no-math] [--mermaid | --no-mermaid]
       [--search | --no-search] [--show-source | --no-show-source] [-t
       DIR] [-h HOST] [-p PORT] [-n] [--help] [--version] [module ...]

and what does it do? Automatically generate API docs for Python modules. 🦋 no cap, it just reads your code and makes it pretty. main character behavior honestly.

---

🎀 Main Arguments: 🎀

• module — Python module names, bestie! these can be importable Python module names like "pdoc.doc", or file paths like "./pdoc/doc.py". wanna exclude submodules? hit it with a negative !regex pattern, e.g. "foo !foo.bar". (default: []) 🙈
• -o DIR, --output-directory DIR — write the rendered documentation into the directory you name, and don't start a webserver. just files, no server, periodt. (default: None) 📁

---

💜 Customize Rendering: 💜

• -d {markdown,google,numpy,restructuredtext}, --docformat {markdown,google,numpy,restructuredtext} — the default docstring format, iykyk. for the non-Markdown formats, pdoc will first convert matching syntax elements to Markdown and then process everything as Markdown. (default: restructuredtext) 🌈
• --include-undocumented, --no-include-undocumented — show classes/functions/variables that do not have a docstring. yes, the shy ones. (default: True) 👀
• -e module=url, --edit-url module=url — a mapping between module names and URL prefixes, used to display an 'Edit' button. may be passed multiple times (stack 'em up 🫶). example: pdoc=https://github.com/mitmproxy/pdoc/blob/main/pdoc/ (default: []) ✏️
• --favicon URL — specify a custom favicon URL. tiny icon, huge vibe. (default: None) ⭐
• --footer-text TEXT — custom text for the page footer, for example the project name and current version number. (default: None) 🍓
• --logo URL — add a project logo image. branding!! (default: None) 🎀
• --logo-link URL — optional URL the logo should point to. (default: None) 🔗
• --math, --no-math — include MathJax from a CDN to enable math formula rendering. (default: False) ➗
• --mermaid, --no-mermaid — include Mermaid.js from a CDN to enable Mermaid diagram rendering. (default: False) 🧜‍♀️
• --search, --no-search — enable search functionality if multiple modules are documented. (default: True) 🔍
• --show-source, --no-show-source — display "View Source" buttons. (default: True) 📜
• -t DIR, --template-directory DIR — a directory containing Jinja2 templates to customize output. alternatively, put your templates in $XDG_CONFIG_HOME/pdoc and pdoc will automatically find them. it's giving convenience. (default: None) 🧚

---

🦋 Miscellaneous Options: 🦋

• -h HOST, --host HOST — the host on which to run the HTTP server. (default: localhost) 🏠
• -p PORT, --port PORT — the port on which to run the HTTP server. (default: None) 🚪
• -n, --no-browser — don't open a browser after the web server has started. (default: False) 🙅‍♀️
• --help — show this help message and exit. 🆘
• --version — show version information and exit. 🏷️

also, for the record, the run that generated all this was on: Python: 3.11.9 and Platform: Linux-6.1.0-21-arm64-aarch64-with-glibc2.38 💀 (that platform string is a whole novel fr fr)

---

👑 SEE ALSO 👑

the full documentation for pdoc: is maintained as a Texinfo manual. if the info and pdoc: programs are properly installed at your site, the command

info pdoc:

should give you access to the complete manual. iconic behavior tbh. 📖

---

okay that's the whole page!! this was pdoc: 14.5.0, dated June 2024. slay, you read the entire thing, so proud of you bestie 💖✨🎀🦋🌸💅🫶