Update docs and README (#17)

* Move readme content to index.rst

* Clean up project name

* Add advanced configuration
This commit is contained in:
Jared Dillard
2025-05-18 21:10:49 -07:00
committed by GitHub
parent da7ee68076
commit 8f4d2c07c6
6 changed files with 212 additions and 113 deletions
+14 -13
View File
@@ -5,7 +5,8 @@ Project Configuration Values
- **Type**: boolean
- **Default**: ``True``
- **Description**: Whether to write the single output file
- **Description**: Whether to write the single output file.
See :ref:`disabling_file_generation`.
.. versionadded:: 0.1.0
@@ -13,7 +14,8 @@ Project Configuration Values
- **Type**: string
- **Default**: ``'llms-full.txt'``
- **Description**: Name of the single output file
- **Description**: Name of the single output file.
See :ref:`changing_filenames`.
.. versionadded:: 0.1.0
@@ -23,6 +25,7 @@ Project Configuration Values
- **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
@@ -30,7 +33,8 @@ Project Configuration Values
- **Type**: boolean
- **Default**: ``True``
- **Description**: Whether to write the summary information file
- **Description**: Whether to write the summary information file.
See :ref:`disabling_file_generation`.
.. versionadded:: 0.2.0
@@ -38,7 +42,8 @@ Project Configuration Values
- **Type**: string
- **Default**: ``llms.txt``
- **Description**: Name of the summary information file
- **Description**: Name of the summary information file.
See :ref:`changing_filenames`.
.. versionadded:: 0.2.0
@@ -47,6 +52,7 @@ Project Configuration Values
- **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
@@ -55,6 +61,7 @@ Project Configuration Values
- **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
@@ -63,6 +70,7 @@ Project Configuration Values
- **Type**: string or ``None``
- **Default**: ``None``
- **Description**: Optional, but recommended, summary description for ``llms.txt``.
See :ref:`custom_summary`.
.. versionadded:: 0.2.0
@@ -70,14 +78,7 @@ Project Configuration Values
- **Type**: list of strings
- **Default**: ``[]``
- **Description**: A list of pages to ignore (e.g., ``["page1", "page_with_*"]``).
- **Description**: A list of pages to ignore.
See :ref:`excluding_content`.
.. versionadded:: 0.2.1
.. confval:: llms_txt_rm_directives
- **Type**: boolean
- **Default**: ``False``
- **Description**: Whether to remove all directives from the output files.
.. versionadded:: 0.2.3