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.
- GreatDocs.spell_check()
-
Check spelling in documentation files and optionally docstrings.