AUTODOC2(1)

📦 version 0.5.0, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

🎀 NAME 🎀

okay bestie, gather round, because this is autodoc2 — the Sphinx extension that automatically generates API docs for Python packages. yes, for real, no more hand-writing docstrings into rst at 2am, we are FED 💅

✨ DESCRIPTION ✨

So here's the whole vibe. You run it like this, fr fr:

Usage: autodoc2 [OPTIONS] COMMAND [ARGS]...

It's the CLI for sphinx-autodoc2, and it's lowkey carrying the whole documentation game on its back 🫶

🌸 Options

  • --version, -v — shows you the application version and then dips, exit stage left ✨
  • --install-completion — installs shell completion for whatever shell you're currently living in 💖
  • --show-completion — shows you the completion for your current shell, so you can copy it or customize the installation to your heart's content 🎀
  • --help, -h — shows this message and exits. the classic. the icon 👑

🦋 Commands

  • create-db — creates a database for a python module or package 🗂️
  • list — analyses a python module or package and streams the results straight to the console, live, main character energy 📺
  • resolve-all — analyses the __all__ of a module and finds potential matches 🔍
  • write — creates sphinx files for a python module or package 📝

🌈 SEE ALSO 🌈

The full documentation for autodoc2 is maintained as a Texinfo manual — yes, Texinfo, we love a retro moment 💜 If the info and autodoc2 programs are properly installed at your site, then this:

info autodoc2

should give you access to the complete manual. iykyk 🌟

okay that's the whole page bestie, go forth and document 📚✨ this was autodoc2 version 0.5.0, from August 2024 — periodt, no cap, mwah 💋💖

📦 where this page comes from