Jared DillardandGitHub
8f4d2c07c6
* Move readme content to index.rst * Clean up project name * Add advanced configuration
85 lines
2.2 KiB
ReStructuredText
85 lines
2.2 KiB
ReStructuredText
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``.
|
|
If exceeded, the file is skipped and a warning is shown, but the build still completes.
|
|
See :ref:`handling_large_documentation`.
|
|
|
|
.. versionadded:: 0.2.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 or ``None``
|
|
- **Default**: ``None``
|
|
- **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.
|
|
See :ref:`excluding_content`.
|
|
|
|
.. versionadded:: 0.2.1
|