# API Reference


The API reference for Great Docs is organized around the `GreatDocs` class, which provides all of the methods needed to initialize, build, and deploy documentation sites.


## The GreatDocs Class


The central class that orchestrates site initialization, building, and deployment for your Python package documentation.


[GreatDocs](GreatDocs.md#great_docs.GreatDocs)  
GreatDocs class for creating beautiful API documentation sites.


## GreatDocs Methods


Methods for installing dependencies, building the documentation site, launching a live preview, and validating links across all pages.


[GreatDocs.install()](GreatDocs.install.md#great_docs.GreatDocs.install)  
Initialize great-docs in your project.

[GreatDocs.uninstall()](GreatDocs.uninstall.md#great_docs.GreatDocs.uninstall)  
Remove great-docs configuration and build directory from the project.

[GreatDocs.build()](GreatDocs.build.md#great_docs.GreatDocs.build)  
Build the documentation site.

[GreatDocs.preview()](GreatDocs.preview.md#great_docs.GreatDocs.preview)  
Preview the documentation site locally.

[GreatDocs.check_links()](GreatDocs.check_links.md#great_docs.GreatDocs.check_links)  
Check all links in source code and documentation for broken links.


## Table Preview/Explorer


Generate styled HTML table previews from any tabular data source with `tbl_preview()`, and explore tables interactively with `tbl_explorer()`.


[tbl_preview()](tbl_preview.md#great_docs.tbl_preview)  
Generate a self-contained HTML table preview from almost any tabular data source.

[enable_tbl_preview()](enable_tbl_preview.md#great_docs.enable_tbl_preview)  
Register `tbl_preview()` as the default DataFrame display formatter.

[disable_tbl_preview()](disable_tbl_preview.md#great_docs.disable_tbl_preview)  
Remove the `tbl_preview()` display formatter and restore defaults.

[tbl_explorer()](tbl_explorer.md#great_docs.tbl_explorer)  
Generate an interactive table explorer from almost any tabular data source.


## Skills


Install, check, and list Agent Skills from the Python API.


[install_skill()](install_skill.md#great_docs.install_skill)  
Install a SKILL.md file for AI coding agents.

[check_skill()](check_skill.md#great_docs.check_skill)  
Check if installed skills are up to date.

[list_skills()](list_skills.md#great_docs.list_skills)  
List available skills from a package or URL.