Great Docs

Documentation sites for Python packages. Three commands. Zero friction.

Links

View on PyPI
Browse source code
Report a bug

AI / Agents

Skills
llms.txt
llms-full.txt

Developers

Rich Iannone

Maintainer

Posit, PBC

Tomasz Kalinowski

Contributor

Posit, PBC

Posit Software, PBC

Copyright holder, funder

Community

Contributing guide
Code of conduct
Project roadmap
Security policy
Full license MIT
Citing great-docs

Meta

Requires: Python >=3.11
Provides-Extra: svg, dev, docs
Tags

Give your Python package the documentation site it deserves. Great Docs turns your docstrings, README, and CLI into a polished documentation site. When you’re ready to go further, there’s a world of features waiting. Start simple, go deep.

Three Commands. One Beautiful Site.

pip install great-docs

cd your-python-package
great-docs init      # scans your package, writes the config
great-docs build     # generates everything, renders with Quarto
great-docs preview   # live preview at localhost:3000

That’s it. Your API reference, CLI docs, and landing page are ready to go. Push to GitHub and you’re live.

Your Docstrings, Finally Doing Their Job

Every class, function, method, and attribute in your public API gets its own structured page with parameter tables, return types, source links, and rendered examples. Numpy, Google, and Sphinx docstring styles all work out of the box.

If your package has a Click CLI, that’s documented as well (complete with terminal-style help output and subcommand trees).

Looks Good Without Trying

Dark mode with a persistent toggle. Responsive on every screen. Sidebar search for large APIs. GitHub star counts in the corner.

With a line or two of configuration you can add animated gradient navbars, announcement banners, custom logos, and more.

Your package gets a site that matches the quality of the code behind it.

AI-Native from Day One

Great Docs generates llms.txt and llms-full.txt so AI coding agents can understand your library without scraping HTML. It also produces Agent Skills files: structured metadata that tells tools like Copilot, Cursor, and Claude Code how to use your package (not just what it exports).

You can also write your own custom skills and publish them with your site. Your users install them with a single command.

Deploy in One Step

great-docs setup-github-pages

Creates a GitHub Actions workflow. Every push to main rebuilds and publishes your site automatically.

Go Further

📖 User Guide Installation, configuration, theming, multi-version docs, and deployment. → 🍳 Recipes Bite-sized guides for specific tasks: copy, paste, done. → ⚙️ API Reference Great Docs documenting itself (every class, function, and option). →

There's Always More to Explore.

Auto-Generated API Ref­er­ence • Dark Mode Toggle • llms.txt & Agent Skills • Multi-Version Docu­men­ta­tion • GitHub Pages in One Com­mand • Click CLI Docu­men­ta­tion • Animated Gradient Nav­bars & Ban­ners • Three Com­mands to Launch • Change­log from GitHub Re­leases • Hero Section Support • Rich Table Pre­views for Pandas, Polars & Arrow

Numpy, Google & Sphinx Doc­strings • Version Selector Widget • Side­bar Search & Fil­ter­ing • Page Tags & Status Badges • Mer­maid Dia­gram Ren­der­ing • Inter­active Table Ex­plor­er • Docu­men­ta­tion Linter • Spelling & Grammar Check­ing • Twenty-Three Lan­guages • Key­board Navi­ga­tion • Custom Sections & Recipes • Respon­sive on Every Screen • GitHub Star Count Widget • SEO Audit & Site­map Gen­er­a­tion • Announce­ment Ban­ners • Auto-Detected Logos with Dark-Mode Vari­ants • API Diff Between Ver­sions • Tool­tips & Pop­overs • Rich Meta­data Side­bar with De­vel­oper Links • Code Auto­links in Doc­strings • Sub­mod­ule Intro­spec­tion • Copy & View Page as Mark­down 

APCA Contrast Algo­rithm • Fav­icon Auto-Gen­er­a­tion • Scale-to-Fit Wide Tables • Copy Code Buttons • Syn­tax High­light­ing & Exe­cut­able Code Blocks • In­line Icons • Version Fences & Badges • Breaking Change Detec­tion • API Sur­face Time­line • Param­eter Evo­lu­tion Tables • JSON-LD Struc­tured Data • Canon­ical URLs • Social Cards & Open Graph • Source Links to GitHub • 1,941 Bundled Lucide Icons • Commu­nity File Pages • SPDX License Data­base • PR Pre­view Deploy­ments • Custom SCSS Theming • Blog Sup­port • Cross-Refs, %see­also & In­line Inter­links • Video Embeds • Color Swatches • Tab­sets & Cal­louts • Link Checker • Config Gen­er­a­tion • Robots.txt & Crawl Rules • Non-Breaking Re­build Mode • API Snap­shots to JSON • Custom Static Pages • Object-Type Label Colors • Styled Sig­na­tures & Type Anno­ta­tions • Meth­od Mem­ber Con­trol & Ex­clude Lists • Nav­bar & Side­bar Icons • Verbose Build Log­ging • Custom Head In­jec­tion for Scripts & Meta • Back-to-Top Button • ...and Yes, It Builds Fast

---

Something missing? Open an issue.