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.
Classes
Core classes and types.
- GreatDocs
-
GreatDocs class for creating beautiful API documentation sites.
GreatDocs Methods
Methods for the GreatDocs class.
- GreatDocs.install()
-
Initialize great-docs in your project.
- GreatDocs.uninstall()
-
Remove great-docs configuration and build directory from the project.
- GreatDocs.build()
-
Build the documentation site.
- GreatDocs.preview()
-
Preview the documentation site locally.
- 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()
-
Generate a self-contained HTML table preview from almost any tabular data source.
- enable_tbl_preview()
-
Register
tbl_preview()as the default DataFrame display formatter. - disable_tbl_preview()
-
Remove the
tbl_preview()display formatter and restore defaults. - tbl_explorer()
-
Generate an interactive table explorer from almost any tabular data source.
Agent Skills
Install, check, and list Agent Skills from the Python API.
- install_skill()
-
Install a SKILL.md file for AI coding agents.
- check_skill()
-
Check if installed skills are up to date.
- list_skills()
-
List available skills from a package or URL.