GreatDocs.install()

Initialize great-docs in your project.

Usage

Source

GreatDocs.install(force=False)

This method creates a great-docs.yml configuration file in the project root with discovered exports and sensible defaults. The docs directory and assets will be created later during the build process.

Note

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

Parameters

force: bool = False

If True, overwrite existing great-docs.yml without prompting. Default is False.

Examples

Initialize great-docs in the current directory:

from great_docs import GreatDocs

docs = GreatDocs()
docs.install()

Initialize in a specific project directory, overwriting existing config:

docs = GreatDocs("/path/to/my/project")
docs.install(force=True)