great-docs

Great Docs: Beautiful documentation for Python packages.

great-docs [OPTIONS] COMMAND [ARGS]...

Great Docs generates professional documentation sites with auto-generated API references, CLI documentation, smart navigation, and modern styling.

Get started with great-docs init to set up your docs, then use great-docs build to generate your site.

Full --help output

Usage: great-docs [OPTIONS] COMMAND [ARGS]...

  Great Docs: Beautiful documentation for Python packages.

  Great Docs generates professional documentation sites with auto-generated
  API references, CLI documentation, smart navigation, and modern styling.

  Get started with 'great-docs init' to set up your docs, then use 'great-docs
  build' to generate your site.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  init                Initialize great-docs in your project (one-time...
  build               Build your documentation site.
  preview             Preview your documentation locally.
  uninstall           Remove great-docs from your project.
  config              Generate a great-docs.yml configuration file.
  scan                Discover package exports and preview what can be...
  freeze              Execute specific pages and persist their freeze cache.
  timings             Show page-level build timings from the last build.
  setup-github-pages  Set up automatic deployment to GitHub Pages.
  check-links         Check for broken links in source code and...
  changelog           Generate a Changelog page from GitHub Releases.
  proofread           Check spelling and grammar in documentation files...
  seo                 Audit SEO health of your documentation site.
  lint                Lint documentation quality for your package.
  api-diff            Compare the public API between two versions.
  versions            List configured documentation versions.
  api-snapshot        Capture a JSON snapshot of a package's public API.
  skill               Manage AI coding agent skills.

Options

--version: Show the version and exit.

Commands

init: Initialize great-docs in your project (one-time bootstrap).
build: Build your documentation site.
preview: Preview your documentation locally.
uninstall: Remove great-docs from your project.
config: Generate a great-docs.yml configuration file.
scan: Discover package exports and preview what can be documented.
freeze: Execute specific pages and persist their freeze cache.
timings: Show page-level build timings from the last build.
setup-github-pages: Set up automatic deployment to GitHub Pages.
check-links: Check for broken links in source code and documentation.
changelog: Generate a Changelog page from GitHub Releases.
proofread: Check spelling and grammar in documentation files using Harper.
seo: Audit SEO health of your documentation site.
lint: Lint documentation quality for your package.
api-diff: Compare the public API between two versions.
versions: List configured documentation versions.
api-snapshot: Capture a JSON snapshot of a package’s public API.
skill: Manage AI coding agent skills.