Update docs and README (#17)
* Move readme content to index.rst * Clean up project name * Add advanced configuration
This commit is contained in:
@@ -5,87 +5,9 @@ A Sphinx extension that generates a summary `llms.txt` file, written in Markdown
|
||||
[](https://pypi.python.org/pypi/sphinx-llms-txt)
|
||||
[](https://pepy.tech/project/sphinx-llms-txt)
|
||||
|
||||
## Installation
|
||||
## Documentation
|
||||
|
||||
```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_full_file`
|
||||
|
||||
- **Type**: boolean
|
||||
- **Default**: `'True'`
|
||||
- **Description**: Whether to write the single output file
|
||||
|
||||
### `llms_txt_full_filename`
|
||||
|
||||
- **Type**: string
|
||||
- **Default**: `'llms-full.txt'`
|
||||
- **Description**: Name of the single output file
|
||||
|
||||
### `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.
|
||||
|
||||
### `llms_txt_file`
|
||||
|
||||
- **Type**: boolean
|
||||
- **Default**: `True`
|
||||
- **Description**: Whether to write the summary information file
|
||||
|
||||
### `llms_txt_filename`
|
||||
|
||||
- **Type**: string
|
||||
- **Default**: `llms.txt`
|
||||
- **Description**: Name of the summary information file
|
||||
|
||||
### `llms_txt_directives`
|
||||
|
||||
- **Type**: list of strings
|
||||
- **Default**: `[]`
|
||||
- **Description**: List of custom directive names to process for path resolution.
|
||||
|
||||
### `llms_txt_title`
|
||||
|
||||
- **Type**: string or `None`
|
||||
- **Default**: `None`
|
||||
- **Description**: Overrides the Sphinx project name as the heading in `llms.txt`.
|
||||
|
||||
### `llms_txt_summary`
|
||||
|
||||
- **Type**: string or `None`
|
||||
- **Default**: `None`
|
||||
- **Description**: Optional, but recommended, summary description for `llms.txt`.
|
||||
|
||||
### `llms_txt_exclude`
|
||||
|
||||
- **Type**: list of strings
|
||||
- **Default**: `[]`
|
||||
- **Description**: A list of pages to ignore (e.g., `["page1", "page_with_*"]`).
|
||||
|
||||
## Features
|
||||
|
||||
- Creates `llms.txt` and `llms-full.txt`
|
||||
- Automatically add content from `include` directives
|
||||
- Resolves relative paths in directives like `image` and `figure` to use full paths
|
||||
- Ability to add list of custom directives with `llms_txt_directives`
|
||||
- Optionally, prepend a base URL using Sphinx's `html_baseurl`
|
||||
- Ability to exclude pages
|
||||
See [sphinx-llms-txt documentation](https://sphinx-llms-txt.readthedocs.io/en/latest/index.html) for installation and configuration instructions.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user