Project Configuration Values

llms_txt_full_file

• Type: boolean

• Default: True

• Description: Whether to write the single output file. See Disabling File Generation.

Added in version 0.1.0.

llms_txt_full_filename

• Type: string

• Default: 'llms-full.txt'

• Description: Name of the single output file. See Changing Filenames.

Added in version 0.1.0.

llms_txt_full_max_size

• Type: integer or None

• Default: None (no limit)

• Description: Sets a maximum line count for llms_txt_full_filename. Behavior when exceeded is controlled by llms_txt_full_size_policy. See Handling Large Documentation.

Added in version 0.2.0.

llms_txt_full_size_policy

• Type: string

• Default: 'warn_skip'

• Description: Controls what happens when llms_txt_full_max_size is exceeded. Format is <loglevel>_<action>. Log levels: warn, info. Actions: skip, keep, note. See Handling Large Documentation.

Added in version 0.5.0.

llms_txt_file

• Type: boolean

• Default: True

• Description: Whether to write the summary information file. See Disabling File Generation.

Added in version 0.2.0.

llms_txt_filename

• Type: string

• Default: llms.txt

• Description: Name of the summary information file. See Changing Filenames.

Added in version 0.2.0.

llms_txt_uri_template

• Type: string or None

• Default: None

• Description: Template string for generating URIs in llms.txt. See Customizing URI Links in llms.txt.

Added in version 0.7.0.

llms_txt_directives

• Type: list of strings

• Default: [] (empty list)

• Description: List of custom directive names to process for path resolution. See Path Resolution.

Added in version 0.1.0.

llms_txt_title

• Type: string or None

• Default: None

• Description: Overrides the Sphinx project name as the heading in llms.txt. See Custom Title.

Added in version 0.2.0.

llms_txt_summary

• Type: string

• Default: The first paragraph in the root document, else an empty string

• Description: Optional, but recommended, summary description for llms.txt. See Adding a Custom Summary.

Added in version 0.2.0.

llms_txt_exclude

• Type: list of strings

• Default: []

• Description: A list of pages to ignore using glob patterns. See Excluding Content.

Added in version 0.2.1.

llms_txt_code_files

• Type: list of strings

• Default: []

• Description: A list of glob patterns that appends source code files to llms_txt_full_filename. See Including Source Code Files.

Added in version 0.4.0.

llms_txt_code_base_path

• Type: string or None

• Default: None (auto-detect from git root)

• Description: Base path to strip from code file paths when displaying titles. When None, automatically detects the relative path from the Sphinx source directory to the git root and strips that prefix from file paths.

Added in version 0.4.0.