Changelog

This changelog is generated automatically from GitHub Releases.

v0.1

2026-03-20 · GitHub

Initial release – An easy-to-use documentation site generator for Python packages.

Highlights

Great Docs turns your Python package into a polished, modern documentation site with minimal setup. Run great-docs init, great-docs build, and you’re done.

Core Features

  • Automatic API reference generation from your package’s public API, with support for NumPy, Google, and Sphinx docstring styles
  • CLI documentation auto-generated from Click-based command groups
  • User guide support with Quarto-based markdown (.qmd) files
  • Built-in recipes – 18 step-by-step guides covering common documentation tasks
  • GitHub Pages deployment with one command (great-docs setup-github-pages), including PR preview deployments

CLI Commands

Command Description
great-docs init Initialize docs config with auto-discovered API structure
great-docs build Build the documentation site (supports --watch mode)
great-docs preview Serve the site locally
great-docs scan Inspect discoverable API symbols
great-docs config Generate a template config with all options
great-docs check-links Validate URLs across source and docs
great-docs spell-check Check documentation spelling with custom dictionaries
great-docs setup-github-pages Generate a GitHub Actions workflow for deployment
great-docs uninstall Remove generated docs files

Styling & Theming

  • Modern default theme with dark mode toggle
  • 8+ navbar gradient presets (sky, peach, lilac, mint, ocean, sunset, forest, …)
  • Custom navbar colors with automatic APCA contrast selection
  • Logo support with light/dark variants and auto-generated favicons
  • Hero section for landing pages
  • Announcement banners (dismissible, styled)

LLM & AI Integration

  • Auto-generates llms.txt and llms-full.txt for LLM consumption
  • Generates SKILL.md conforming to the Agent Skills specification
  • Serves skills at /.well-known/skills/ for AI agent discovery

Configuration

All options live in a single great-docs.yml file. See great-docs config for the full list, or visit the documentation.

Requirements

  • Python >= 3.11
  • Quarto (must be installed separately)