GreatDocs.uninstall()

Remove Great Docs configuration and generated build directories

Usage

Source

GreatDocs.uninstall()

Delete great-docs.yml and the current great-docs/ build directory. Also delete each historical great-docs-<tag>/ directory that is not a symlink and contains the complete generated-file header. Preserve symlinks and historical directories without this header.

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()