great-docs init

Initialise documentation in your project

great-docs init [OPTIONS]

Creates a fresh docs/great-docs.yml configuration file with discovered package exports and sensible defaults. Refuses to run if the selected configuration already exists (use --force to reset).

• Creates docs/great-docs.yml with discovered API exports
• Auto-detects your package name and public API
• Updates .gitignore to exclude the build directory
• Detects docstring style (numpy, google, sphinx)

After init, customise docs/great-docs.yml then use great-docs build for all subsequent builds. You should never need to run great-docs init again unless you want to completely reset your configuration.

Full --help output

Usage: great-docs init [OPTIONS]

  Initialise documentation in your project

  Creates a fresh 'docs/great-docs.yml' configuration file with discovered
  package exports and sensible defaults. Refuses to run if the selected
  configuration already exists (use '--force' to reset).

  • Creates 'docs/great-docs.yml' with discovered API exports
  • Auto-detects your package name and public API
  • Updates .gitignore to exclude the build directory
  • Detects docstring style (numpy, google, sphinx)

  After init, customise 'docs/great-docs.yml' then use 'great-docs build' for
  all subsequent builds. You should never need to run 'great-docs init' again
  unless you want to completely reset your configuration.

  Examples:
    great-docs init                       # Initialize in current directory
    great-docs init --force               # Reset config to defaults
    great-docs init --project-path ../pkg # Initialize in another project

Options:
  --project-path DIRECTORY  Path to your project root directory (default:
                            current directory)
  --force                   Delete existing great-docs.yml and generate a
                            fresh default config
  --config FILE             Path to the project configuration file
  --help                    Show this message and exit.

Options

--project-path: DIRECTORY

Path to your project root directory (default: current directory)

--force

Delete existing great-docs.yml and generate a fresh default config

--config: FILE

Path to the project configuration file

Examples

  great-docs init                       # Initialize in current directory
  great-docs init --force               # Reset config to defaults
  great-docs init --project-path ../pkg # Initialize in another project