GreatDocs.uninstall()

Remove great-docs configuration and build directory from the project.

Usage

Source

GreatDocs.uninstall()

This method deletes the great-docs.yml configuration file and the great-docs/ build directory (if it exists).

Note

In practice, you would normally use the great-docs uninstall CLI command rather than calling this method directly. See the CLI reference for details.

Examples

Uninstall great-docs from the current directory:

from great_docs import GreatDocs

docs = GreatDocs()
docs.uninstall()

Uninstall from a specific project directory:

docs = GreatDocs("/path/to/my/project")
docs.uninstall()