Support customizable URI templates in llms.txt (#48)
This commit is contained in:
@@ -261,6 +261,37 @@ If you want to include absolute URLs for resources in your documentation, you ca
|
||||
|
||||
When this option is set, all resolved paths in directives will be prefixed with this URL, creating absolute paths in the generated files.
|
||||
|
||||
.. _customizing_uri_links:
|
||||
|
||||
Customizing URI Links in llms.txt
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
By default, the ``llms.txt`` file links to source files in the ``_sources`` directory when available, falling back to HTML pages when sources aren't available.
|
||||
You can customize this behavior using URI templates with :confval:`llms_txt_uri_template`:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
# Default: Link to source files, if _sources exists
|
||||
llms_txt_uri_template = "{base_url}_sources/{docname}{suffix}{sourcelink_suffix}"
|
||||
|
||||
# Default: Link to HTML pages instead, if _sources doesn't exist
|
||||
llms_txt_uri_template = "{base_url}{docname}.html"
|
||||
|
||||
# Manual: Link to a custom markdown build
|
||||
llms_txt_uri_template = "{base_url}{docname}.md"
|
||||
|
||||
.. _available_template_variables:
|
||||
|
||||
Available Template Variables
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Your URI template can use the following variables:
|
||||
|
||||
- ``{base_url}`` - The base URL from ``html_baseurl`` configuration (includes trailing slash)
|
||||
- ``{docname}`` - The document name (e.g., ``index``, ``guide/intro``)
|
||||
- ``{suffix}`` - The source file suffix (e.g., ``.rst``, ``.md``) - may be empty if no source file exists
|
||||
- ``{sourcelink_suffix}`` - The suffix from ``html_sourcelink_suffix`` configuration (e.g., ``.txt``)
|
||||
|
||||
.. _integration_examples:
|
||||
|
||||
Integration Examples
|
||||
@@ -285,6 +316,7 @@ Here's a complete example showing multiple :doc:`configuration-values`:
|
||||
This is a comprehensive documentation set for our project.
|
||||
It includes API references, usage examples, and tutorials.
|
||||
"""
|
||||
llms_txt_uri_template = "{base_url}{docname}.md"
|
||||
|
||||
# Path handling
|
||||
html_baseurl = "https://docs.example.com/"
|
||||
|
||||
+2
-1
@@ -15,6 +15,7 @@ import subprocess
|
||||
project = "sphinx-llms-txt"
|
||||
copyright = "Jared Dillard"
|
||||
author = "Jared Dillard"
|
||||
llms_txt_uri_template = "{base_url}{docname}.md"
|
||||
llms_txt_code_files = ["+:../../sphinx_llms_txt/*.py"]
|
||||
llms_txt_summary = """
|
||||
A Sphinx extension that generates a summary llms.txt file,written in Markdown,
|
||||
@@ -88,7 +89,7 @@ html_theme_options = {
|
||||
"source_directory": "docs/source/",
|
||||
}
|
||||
|
||||
html_baseurl = "https://sphinx-llms-txt.readthedocs.org/"
|
||||
html_baseurl = "https://sphinx-llms-txt.readthedocs.org/en/latest/"
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
@@ -58,6 +58,15 @@ Project Configuration Values
|
||||
|
||||
.. versionadded:: 0.2.0
|
||||
|
||||
.. confval:: llms_txt_uri_template
|
||||
|
||||
- **Type**: string or ``None``
|
||||
- **Default**: ``None``
|
||||
- **Description**: Template string for generating URIs in ``llms.txt``.
|
||||
See :ref:`customizing_uri_links`.
|
||||
|
||||
.. versionadded:: 0.7.0
|
||||
|
||||
.. confval:: llms_txt_directives
|
||||
|
||||
- **Type**: list of strings
|
||||
|
||||
Reference in New Issue
Block a user