Add advanced configuration
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
You can see this Sphinx project's `llms.txt`_ and `llms-full.txt`_ files as a simple example.
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
@@ -22,3 +27,19 @@ Add the extension to your Sphinx configuration (``conf.py``):
|
||||
]
|
||||
|
||||
Once added, the extension will automatically generate the LLMs.txt files during the build process.
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
Sphinx LLMs.txt provides the following 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
|
||||
|
||||
|
||||
.. _llms.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms.txt
|
||||
.. _llms-full.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms-full.txt
|
||||
|
||||
+2
-20
@@ -9,32 +9,14 @@ A `Sphinx`_ extension that generates a summary ``llms.txt`` file, written in Mar
|
||||
:maxdepth: 2
|
||||
|
||||
getting-started
|
||||
advanced-configuration
|
||||
configuration-values
|
||||
contributing
|
||||
changelog
|
||||
|
||||
Features
|
||||
--------
|
||||
|
||||
Sphinx LLMs.txt provides the following 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
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
You can see this Sphinx projects `llms.txt`_ and `llms-full.txt`_ files as a simple example.
|
||||
|
||||
|
||||
.. _Sphinx: http://sphinx-doc.org/
|
||||
.. _llms.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms.txt
|
||||
.. _llms-full.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms-full.txt
|
||||
|
||||
.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-llms-txt.svg
|
||||
:target: https://pypi.python.org/pypi/sphinx-llms-txt
|
||||
:alt: Latest PyPi Version
|
||||
:alt: Latest PyPi Version
|
||||
Reference in New Issue
Block a user