Great Docs automatically creates professional documentation with auto-generated API references, CLI documentation, smart navigation, and modern styling.
- One-command setup —
great-docs initcreates 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.txtandllms-full.txtfor AI documentation indexing - GitHub Pages ready — one command sets up deployment workflow
Great Docs is not yet available on PyPI, so, install from GitHub:
pip install git+https://github.com/posit-dev/great-docs.gitNavigate to your Python project and run:
great-docs initThis auto-detects your package and creates a great-docs.yml configuration file with your API structure.
great-docs buildThis creates the great-docs/ directory with all assets and builds your site to great-docs/_site/.
great-docs previewOpens the built site in your browser.
great-docs setup-github-pagesCreates a GitHub Actions workflow for automatic deployment.
- 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
--helpoutput in terminal style - User Guide from your
user_guide/directory - Source links to GitHub for every documented item
- Mobile-friendly responsive design
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
MIT License. See LICENSE for details.