great-docs 0.1.0

An easy-to-use documentation site generator for Python packages

Great Docs

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

Features

• One-command setup — great-docs init creates your entire docs site
• Auto-generated API docs — discovers and documents your package's public API
• Docstring detection — automatically detects NumPy, Google, or Sphinx style
• CLI documentation — generates reference pages for Click-based CLIs
• Smart organization — intelligent class/method/function categorization
• User Guide support — write narrative documentation alongside API reference
• Source links — automatic links to source code on GitHub
• LLM-friendly — auto-generates llms.txt and llms-full.txt for AI documentation indexing
• GitHub Pages ready — one command sets up deployment workflow

Quick Start

Install

Great Docs is not yet available on PyPI, so, install from GitHub:

pip install git+https://github.com/posit-dev/great-docs.git

Initialize

Navigate to your Python project and run:

great-docs init

This auto-detects your package and creates a great-docs.yml configuration file with your API structure.

Build

great-docs build

This creates the great-docs/ directory with all assets and builds your site to great-docs/_site/.

Preview

great-docs preview

Opens the built site in your browser.

Deploy

great-docs setup-github-pages

Creates a GitHub Actions workflow for automatic deployment.

What You Get

• Landing page from your README with a metadata sidebar (authors, license, links)
• API reference with classes, functions, and methods organized and styled
• CLI reference with --help output in terminal style
• User Guide from your user_guide/ directory
• Source links to GitHub for every documented item
• Mobile-friendly responsive design

Documentation

The User Guide covers:

• Installation
• Quick Start
• Configuration
• Theming & Appearance
• Cross-Referencing
• API Documentation
• CLI Documentation
• User Guides
• Custom Sections
• Blog
• Building & Previewing
• Deployment
• Link Checker
• Spell Checking
• Changelog

License

MIT License. See LICENSE for details.