49 lines
998 B
Markdown
49 lines
998 B
Markdown
# Sphinx llms-full.txt Extension
|
|
|
|
A Sphinx extension that creates a single combined documentation `llms-full.txt` file, written in reStructuredText.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install sphinx-llms-txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
1. Add the extension to your Sphinx configuration (`conf.py`):
|
|
|
|
```python
|
|
extensions = [
|
|
'sphinx_llms_txt',
|
|
]
|
|
```
|
|
|
|
## Configuration Options
|
|
|
|
### `llms_txt_filename`
|
|
|
|
- **Type**: string
|
|
- **Default**: `'llms-full.txt'`
|
|
- **Description**: Name of the output file
|
|
|
|
### `llms_txt_verbose`
|
|
|
|
- **Type**: boolean
|
|
- **Default**: `False`
|
|
- **Description**: Whether to include a summary in the build output
|
|
|
|
### `llms_txt_max_lines`
|
|
|
|
- **Type**: integer or `None`
|
|
- **Default**: `None` (no limit)
|
|
- **Description**: Sets a maximum line count for `llms_txt_filename`. If exceeded, the file is skipped and a warning is shown, but the build still completes.
|
|
|
|
## Features
|
|
|
|
- Automatically add content from `.. include::` directives
|
|
|
|
|
|
## License
|
|
|
|
MIT License - see LICENSE file for details.
|