Generate Quarto-based documentation sites for Python packages via API discovery.
npx skills add https://github.com/posit-dev/great-docs --skill great-docs
Please help me install this Agent Skill. Skill: great-docs Source: https://github.com/posit-dev/great-docs/tree/main/skills/great-docs Command: npx skills add https://github.com/posit-dev/great-docs --skill great-docs
Great Docs automates the process of turning Python packages into a polished, fully rendered documentation site, eliminating tedious, manual setup and keeping docs in sync with code.
Run great-docs init in your project root to auto-discover your package and generate a starter configuration.
High-intent search queries and answers about installing and using this skill.
To generate API reference documentation automatically, use great-docs to discover your Python package's public API and render a structured Quarto site covering classes, functions, and modules. Running the init command creates a starter configuration to begin the process.
Building a Quarto documentation site from Python code is handled by configuring great-docs.yml and running the build command. This renders user guides, CLI docs, and API references into a polished static site without manual setup.
You can customize theming and deployment configuration for Python package docs through the great-docs.yml file. Optional scripts, references, and assets directories allow further workflow extension for landing pages, changelogs, and agent contexts.
Yes, this documentation generator works with Python packages that have a CLI by automatically discovering the interface and rendering dedicated command-line documentation within the generated Quarto site.
To preview Python package documentation locally before deployment, run the preview command provided by the workflow. This serves the rendered Quarto static site so you can verify API references and guides.
dwalleckInspect public API surfaces of .NET libraries and NuGet packages.
clearsmogPublish rendered Quarto slides, Typst PDFs, and LaTeX projects to a hosted output directory.
posit-devCreate and migrate Quarto documents with YAML front matter and extensions.
windyskyGenerate documentation patterns from code for Sphinx, MkDocs, TypeDoc, and Nextra.
