Metadata-Version: 2.4
Name: great-docs
Version: 0.1.0
Summary: An easy-to-use documentation site generator for Python packages
Author-email: Rich Iannone <riannone@me.com>
Maintainer-email: Rich Iannone <riannone@me.com>
License: MIT License
        
        Copyright (c) 2026 Posit Software, PBC
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/posit-dev/great-docs
Project-URL: Repository, https://github.com/posit-dev/great-docs
Project-URL: Documentation, https://posit-dev.github.io/great-docs/
Project-URL: Bug Tracker, https://github.com/posit-dev/great-docs/issues
Keywords: documentation,documentation-generator,api-documentation,quarto,python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jupyter>=1.1.1
Requires-Dist: py-yaml12>=0.1.0
Requires-Dist: click>=8.0.0
Requires-Dist: griffe<2.0.0,>=0.35.0
Requires-Dist: pygments>=2.0.0
Requires-Dist: requests>=2.25.0
Requires-Dist: pyspellchecker>=0.7.0
Requires-Dist: tabulate>=0.9.0
Requires-Dist: Pillow>=9.0.0
Requires-Dist: cairosvg>=2.5.0
Requires-Dist: ruff>=0.9.9
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=3.0; extra == "dev"
Requires-Dist: pytest-xdist>=3.5; extra == "dev"
Requires-Dist: ruff>=0.9.9; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: pyright>=1.1.407; extra == "dev"
Requires-Dist: build>=0.7; extra == "dev"
Requires-Dist: twine>=3.4; extra == "dev"
Provides-Extra: docs
Requires-Dist: jupyter>=1.0.0; extra == "docs"
Dynamic: license-file

# Great Docs

[![Python versions](https://img.shields.io/pypi/pyversions/great-docs.svg)](https://pypi.org/project/great-docs/)
[![PyPI](https://img.shields.io/pypi/v/great-docs?logo=python&logoColor=white&color=orange)](https://pypi.org/project/great-docs/)
[![PyPI Downloads](https://img.shields.io/pypi/dm/great-docs)](https://pypistats.org/packages/great-docs)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://choosealicense.com/licenses/mit/)
[![CI Build](https://github.com/posit-dev/great-docs/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/posit-dev/great-docs/actions/workflows/test.yml)
[![Repo Status](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html)

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:

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

### Initialize

Navigate to your Python project and run:

```bash
great-docs init
```

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

### Build

```bash
great-docs build
```

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

### Preview

```bash
great-docs preview
```

Opens the built site in your browser.

### Deploy

```bash
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](https://posit-dev.github.io/great-docs/user-guide/installation.html)
- [Quick Start](https://posit-dev.github.io/great-docs/user-guide/quickstart.html)
- [Configuration](https://posit-dev.github.io/great-docs/user-guide/configuration.html)
- [Theming & Appearance](https://posit-dev.github.io/great-docs/user-guide/theming.html)
- [Cross-Referencing](https://posit-dev.github.io/great-docs/user-guide/cross-referencing.html)
- [API Documentation](https://posit-dev.github.io/great-docs/user-guide/api-documentation.html)
- [CLI Documentation](https://posit-dev.github.io/great-docs/user-guide/cli-documentation.html)
- [User Guides](https://posit-dev.github.io/great-docs/user-guide/user-guides.html)
- [Custom Sections](https://posit-dev.github.io/great-docs/user-guide/custom-sections.html)
- [Blog](https://posit-dev.github.io/great-docs/user-guide/blog.html)
- [Building & Previewing](https://posit-dev.github.io/great-docs/user-guide/building.html)
- [Deployment](https://posit-dev.github.io/great-docs/user-guide/deployment.html)
- [Link Checker](https://posit-dev.github.io/great-docs/user-guide/link-checker.html)
- [Spell Checking](https://posit-dev.github.io/great-docs/user-guide/spell-checker.html)
- [Changelog](https://posit-dev.github.io/great-docs/user-guide/changelog.html)

## License

MIT License. See [LICENSE](https://posit-dev.github.io/great-docs/license.html) for details.
