Project Configuration Values ============================ .. confval:: llms_txt_full_file - **Type**: boolean - **Default**: ``True`` - **Description**: Whether to write the single output file. See :ref:`disabling_file_generation`. .. versionadded:: 0.1.0 .. confval:: llms_txt_full_filename - **Type**: string - **Default**: ``'llms-full.txt'`` - **Description**: Name of the single output file. See :ref:`changing_filenames`. .. versionadded:: 0.1.0 .. confval:: 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 :confval:`llms_txt_full_size_policy`. See :ref:`handling_large_documentation`. .. versionadded:: 0.2.0 .. confval:: llms_txt_full_size_policy - **Type**: string - **Default**: ``'warn_skip'`` - **Description**: Controls what happens when :confval:`llms_txt_full_max_size` is exceeded. Format is ``_``. Log levels: ``warn``, ``info``. Actions: ``skip``, ``keep``, ``note``. See :ref:`handling_large_documentation`. .. versionadded:: 0.5.0 .. confval:: llms_txt_file - **Type**: boolean - **Default**: ``True`` - **Description**: Whether to write the summary information file. See :ref:`disabling_file_generation`. .. versionadded:: 0.2.0 .. confval:: llms_txt_filename - **Type**: string - **Default**: ``llms.txt`` - **Description**: Name of the summary information file. See :ref:`changing_filenames`. .. versionadded:: 0.2.0 .. confval:: llms_txt_directives - **Type**: list of strings - **Default**: ``[]`` (empty list) - **Description**: List of custom directive names to process for path resolution. See :ref:`path_resolution`. .. versionadded:: 0.1.0 .. confval:: llms_txt_title - **Type**: string or ``None`` - **Default**: ``None`` - **Description**: Overrides the Sphinx project name as the heading in ``llms.txt``. See :ref:`custom_title`. .. versionadded:: 0.2.0 .. confval:: 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 :ref:`custom_summary`. .. versionadded:: 0.2.0 .. confval:: llms_txt_exclude - **Type**: list of strings - **Default**: ``[]`` - **Description**: A list of pages to ignore using glob patterns. See :ref:`excluding_content`. .. versionadded:: 0.2.1 .. confval:: llms_txt_code_files - **Type**: list of strings - **Default**: ``[]`` - **Description**: A list of glob patterns that appends source code files to :confval:`llms_txt_full_filename`. See :ref:`including_code_files`. .. versionadded:: 0.4.0 .. confval:: 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. .. versionadded:: 0.4.0