Compare commits
16
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4b21010078 | ||
|
|
c23c6d4468 | ||
|
|
72719e881c | ||
|
|
db32dc60a7 | ||
|
|
dc9f16d454 | ||
|
|
543efabebb | ||
|
|
141e0e29f6 | ||
|
|
1b08b2f362 | ||
|
|
5bfbb0168f | ||
|
|
e2a80faf04 | ||
|
|
b63801bcff | ||
|
|
c45ebb0369 | ||
|
|
f5dcd15889 | ||
|
|
e64e20133a | ||
|
|
52949a952a | ||
|
|
3d7edbf7d9 |
@@ -10,9 +10,9 @@ jobs:
|
||||
pre-commit:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v5
|
||||
- name: Set up Python 3.10
|
||||
uses: actions/setup-python@v5
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: "3.10"
|
||||
- uses: pre-commit/action@v3.0.1
|
||||
@@ -23,17 +23,17 @@ jobs:
|
||||
python-version: ['3.9', '3.10', '3.11', '3.12']
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- name: Set up Python ${{ matrix.python-version }}
|
||||
uses: actions/setup-python@v5
|
||||
uses: actions/setup-python@v6
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
pip install -e ".[dev]"
|
||||
pip install -e . --group dev
|
||||
|
||||
# - name: Run mypy
|
||||
# run: |
|
||||
@@ -52,4 +52,4 @@ jobs:
|
||||
# uses: actions/upload-artifact@v3
|
||||
# with:
|
||||
# name: dist-${{ matrix.python-version }}
|
||||
# path: dist/
|
||||
# path: dist/
|
||||
|
||||
@@ -18,13 +18,6 @@ repos:
|
||||
hooks:
|
||||
- id: flake8
|
||||
|
||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||
rev: v1.11.2
|
||||
hooks:
|
||||
- id: mypy
|
||||
files: ^sphinx_llms_txt/
|
||||
additional_dependencies: [types-docutils]
|
||||
|
||||
- repo: https://github.com/sphinx-contrib/sphinx-lint
|
||||
rev: v1.0.0
|
||||
hooks:
|
||||
|
||||
+13
-11
@@ -1,15 +1,17 @@
|
||||
version: 2
|
||||
|
||||
build:
|
||||
os: "ubuntu-20.04"
|
||||
os: ubuntu-24.04
|
||||
tools:
|
||||
python: "3.10"
|
||||
|
||||
sphinx:
|
||||
configuration: docs/source/conf.py
|
||||
|
||||
python:
|
||||
install:
|
||||
- requirements: docs/requirements.txt
|
||||
- method: pip
|
||||
path: .
|
||||
python: "3.13"
|
||||
commands:
|
||||
- pip install cmake
|
||||
- pip install -r docs/requirements.txt
|
||||
- pip install -e .
|
||||
- cmake --workflow --preset documentation-workflow
|
||||
# Copy built documentation to Read the Docs output directory
|
||||
- mkdir -p $READTHEDOCS_OUTPUT/html
|
||||
- cp -r build/html/* $READTHEDOCS_OUTPUT/html/
|
||||
- cp -r build/markdown/* $READTHEDOCS_OUTPUT/html/
|
||||
- cp -r build/rst/* $READTHEDOCS_OUTPUT/html/
|
||||
- cp build/singlerst/index.rst $READTHEDOCS_OUTPUT/html/llms-full.txt
|
||||
|
||||
@@ -1,6 +1,36 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
0.7.0
|
||||
-----
|
||||
|
||||
- Add :confval:`llms_txt_uri_template` configuration option to control the link behavior in :confval:`llms_txt_filename`.
|
||||
`#48 <https://github.com/jdillard/sphinx-llms-txt/pull/48>`_
|
||||
|
||||
0.6.0
|
||||
-----
|
||||
|
||||
- Improve _sources directory handling
|
||||
`#47 <https://github.com/jdillard/sphinx-llms-txt/pull/47>`_
|
||||
|
||||
0.5.3
|
||||
-----
|
||||
|
||||
- Make sphinx a required dependency since there are imports from Sphinx
|
||||
`#44 <https://github.com/jdillard/sphinx-llms-txt/pull/44>`_
|
||||
|
||||
0.5.2
|
||||
-----
|
||||
|
||||
- Remove support for singlehtml
|
||||
`#40 <https://github.com/jdillard/sphinx-llms-txt/pull/40>`_
|
||||
|
||||
0.5.1
|
||||
-----
|
||||
|
||||
- Only allow builders that have _sources directory
|
||||
`#38 <https://github.com/jdillard/sphinx-llms-txt/pull/38>`_
|
||||
|
||||
0.5.0
|
||||
-----
|
||||
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
cmake_minimum_required(VERSION 3.15)
|
||||
project(SphinxLLMsTxt VERSION 1.0.0 LANGUAGES NONE)
|
||||
|
||||
# Add CMake module path
|
||||
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
|
||||
|
||||
# Add documentation
|
||||
add_subdirectory(docs)
|
||||
@@ -0,0 +1,59 @@
|
||||
{
|
||||
"version": 6,
|
||||
"configurePresets": [
|
||||
{
|
||||
"name": "documentation",
|
||||
"displayName": "Documentation Build",
|
||||
"description": "Configure project with documentation environment setup",
|
||||
"binaryDir": "${sourceDir}/build"
|
||||
}
|
||||
],
|
||||
"buildPresets": [
|
||||
{
|
||||
"name": "html",
|
||||
"displayName": "Build HTML Documentation",
|
||||
"configurePreset": "documentation",
|
||||
"targets": ["html"]
|
||||
},
|
||||
{
|
||||
"name": "markdown",
|
||||
"displayName": "Build Markdown Documentation",
|
||||
"configurePreset": "documentation",
|
||||
"targets": ["markdown"]
|
||||
},
|
||||
{
|
||||
"name": "rst",
|
||||
"displayName": "Build reStructuredText Documentation",
|
||||
"configurePreset": "documentation",
|
||||
"targets": ["rst"]
|
||||
},
|
||||
{
|
||||
"name": "singlerst",
|
||||
"displayName": "Build Single reStructuredText Documentation",
|
||||
"configurePreset": "documentation",
|
||||
"targets": ["singlerst"]
|
||||
},
|
||||
{
|
||||
"name": "docs-parallel",
|
||||
"displayName": "Build HTML and Markdown in parallel",
|
||||
"configurePreset": "documentation",
|
||||
"targets": ["html", "markdown", "rst", "singlerst"]
|
||||
}
|
||||
],
|
||||
"workflowPresets": [
|
||||
{
|
||||
"name": "documentation-workflow",
|
||||
"displayName": "Documentation Build Workflow",
|
||||
"steps": [
|
||||
{
|
||||
"type": "configure",
|
||||
"name": "documentation"
|
||||
},
|
||||
{
|
||||
"type": "build",
|
||||
"name": "docs-parallel"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
# Sphinx related utilities
|
||||
|
||||
set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/source)
|
||||
set(SPHINX_BUILD ${CMAKE_BINARY_DIR})
|
||||
|
||||
# Function to find Sphinx in the system
|
||||
function(setup_sphinx_environment)
|
||||
# Find sphinx-build executable in system
|
||||
find_program(SPHINX_EXECUTABLE
|
||||
NAMES sphinx-build
|
||||
DOC "Sphinx documentation generator"
|
||||
)
|
||||
|
||||
if(NOT SPHINX_EXECUTABLE)
|
||||
message(FATAL_ERROR "sphinx-build not found. Please install Sphinx.")
|
||||
endif()
|
||||
|
||||
# Export to parent scope
|
||||
set(SPHINX_EXECUTABLE "${SPHINX_EXECUTABLE}" PARENT_SCOPE)
|
||||
endfunction()
|
||||
|
||||
# Function to add a Sphinx builder target
|
||||
function(add_sphinx_builder builder_name)
|
||||
add_custom_target(${builder_name}
|
||||
COMMAND ${SPHINX_EXECUTABLE} -b ${builder_name} ${SPHINX_SOURCE} ${SPHINX_BUILD}/${builder_name}
|
||||
VERBATIM
|
||||
)
|
||||
endfunction()
|
||||
@@ -0,0 +1,8 @@
|
||||
include(SphinxUtils)
|
||||
|
||||
setup_sphinx_environment()
|
||||
|
||||
add_sphinx_builder(html)
|
||||
add_sphinx_builder(markdown)
|
||||
add_sphinx_builder(rst)
|
||||
add_sphinx_builder(singlerst)
|
||||
@@ -3,4 +3,7 @@ esbonio
|
||||
sphinx-contributors
|
||||
sphinx
|
||||
sphinx-llms-txt
|
||||
sphinx-inline-tabs
|
||||
sphinxext-opengraph
|
||||
sphinx-markdown-builder
|
||||
sphinxcontrib-restbuilder @ git+https://github.com/jdillard/restbuilder.git@feature/singlerst-builder
|
||||
|
||||
@@ -261,6 +261,42 @@ 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``)
|
||||
|
||||
.. tip::
|
||||
Instead of using the default of linking to ``_sources``, you can generate Markdown and/or reStructuredText files from your documentation and link to those in ``llms.txt``.
|
||||
See this package's `CMake setup <https://github.com/jdillard/sphinx-llms-txt>`_ for an example of building both HTML and Markdown and/or reStructuredText in parallel.
|
||||
Note that ``_sources`` is still needed for ``llms-full.txt`` at this time.
|
||||
|
||||
.. _integration_examples:
|
||||
|
||||
Integration Examples
|
||||
@@ -285,6 +321,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/"
|
||||
|
||||
+9
-1
@@ -15,12 +15,18 @@ import subprocess
|
||||
project = "sphinx-llms-txt"
|
||||
copyright = "Jared Dillard"
|
||||
author = "Jared Dillard"
|
||||
|
||||
llms_txt_uri_template = "{base_url}{docname}.md"
|
||||
llms_txt_full_file = False
|
||||
llms_txt_code_files = ["+:../../sphinx_llms_txt/*.py"]
|
||||
llms_txt_summary = """
|
||||
A Sphinx extension that generates a summary llms.txt file,written in Markdown,
|
||||
and a single combined documentation llms-full.txt file, written in reStructuredText.
|
||||
"""
|
||||
|
||||
# This doesn't seem to be supported
|
||||
# rst_file_suffix = ".html.rst"
|
||||
|
||||
# check if the current commit is tagged as a release (vX.Y.Z)
|
||||
try:
|
||||
GIT_TAG_OUTPUT = subprocess.check_output(["git", "tag", "--points-at", "HEAD"])
|
||||
@@ -49,6 +55,8 @@ extensions = [
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx_contributors",
|
||||
"sphinx_llms_txt",
|
||||
"sphinxcontrib.restbuilder",
|
||||
"sphinx_inline_tabs",
|
||||
]
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
@@ -88,7 +96,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
|
||||
|
||||
@@ -19,7 +19,7 @@ Local development
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
pip install -e ".[dev]"
|
||||
pip install -e . --group dev
|
||||
|
||||
#. Install pre-commit Git hook scripts:
|
||||
|
||||
|
||||
@@ -4,17 +4,19 @@ Getting Started
|
||||
Installation
|
||||
------------
|
||||
|
||||
Directly install via ``pip`` by using:
|
||||
Directly install by using:
|
||||
|
||||
.. code-block:: bash
|
||||
.. tab:: via pip
|
||||
|
||||
pip install sphinx-llms-txt
|
||||
.. code-block:: bash
|
||||
|
||||
Or with ``conda`` via ``conda-forge``:
|
||||
pip install sphinx-llms-txt
|
||||
|
||||
.. code::
|
||||
.. tab:: via conda:
|
||||
|
||||
conda install -c conda-forge sphinx-llms-txt
|
||||
.. code-block:: bash
|
||||
|
||||
conda install -c conda-forge sphinx-llms-txt
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
+7
-3
@@ -26,13 +26,16 @@ classifiers = [
|
||||
license = {text = "MIT"}
|
||||
readme = "README.md"
|
||||
dynamic = ["version"]
|
||||
dependencies = [
|
||||
"sphinx",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
download = "https://pypi.org/project/sphinx-llms-txt/"
|
||||
source = "https://github.com/jdillard/sphinx-llms-txt"
|
||||
changelog = "https://github.com/jdillard/sphinx-llms-txt/blob/master/CHANGELOG.rst"
|
||||
|
||||
[project.optional-dependencies]
|
||||
[dependency-groups]
|
||||
dev = [
|
||||
"pytest>=7.0.0",
|
||||
"black",
|
||||
@@ -40,12 +43,13 @@ dev = [
|
||||
"mypy",
|
||||
"isort",
|
||||
"pre-commit",
|
||||
"sphinx",
|
||||
]
|
||||
test = [
|
||||
"pytest>=7.0.0",
|
||||
]
|
||||
|
||||
[tool.setuptools]
|
||||
packages = ["sphinx_llms_txt"]
|
||||
|
||||
[tool.setuptools.dynamic]
|
||||
version = {attr = "sphinx_llms_txt.__version__"}
|
||||
@@ -86,4 +90,4 @@ filterwarnings = [
|
||||
"ignore::UserWarning",
|
||||
"ignore::DeprecationWarning",
|
||||
"ignore::PendingDeprecationWarning",
|
||||
]
|
||||
]
|
||||
|
||||
+17
-10
@@ -21,7 +21,7 @@ from .manager import LLMSFullManager
|
||||
from .processor import DocumentProcessor
|
||||
from .writer import FileWriter
|
||||
|
||||
__version__ = "0.5.0"
|
||||
__version__ = "0.7.0"
|
||||
|
||||
# Export classes needed by tests
|
||||
__all__ = [
|
||||
@@ -85,6 +85,7 @@ def build_finished(app: Sphinx, exception):
|
||||
config = {
|
||||
"llms_txt_file": app.config.llms_txt_file,
|
||||
"llms_txt_filename": app.config.llms_txt_filename,
|
||||
"llms_txt_uri_template": app.config.llms_txt_uri_template,
|
||||
"llms_txt_title": app.config.llms_txt_title,
|
||||
"llms_txt_summary": summary,
|
||||
"llms_txt_full_file": app.config.llms_txt_full_file,
|
||||
@@ -107,15 +108,15 @@ def build_finished(app: Sphinx, exception):
|
||||
_manager.update_page_title(docname, title)
|
||||
|
||||
# Create the combined file
|
||||
_manager.combine_sources(str(app.outdir), str(app.srcdir))
|
||||
_manager.combine_sources(app.outdir, app.srcdir)
|
||||
|
||||
|
||||
def setup(app: Sphinx) -> Dict[str, Any]:
|
||||
"""Set up the Sphinx extension."""
|
||||
|
||||
# Add configuration options
|
||||
app.add_config_value("llms_txt_file", True, "env")
|
||||
app.add_config_value("llms_txt_filename", "llms.txt", "env")
|
||||
app.add_config_value("llms_txt_uri_template", None, "env")
|
||||
app.add_config_value("llms_txt_full_file", True, "env")
|
||||
app.add_config_value("llms_txt_full_filename", "llms-full.txt", "env")
|
||||
app.add_config_value("llms_txt_full_max_size", None, "env")
|
||||
@@ -127,14 +128,20 @@ def setup(app: Sphinx) -> Dict[str, Any]:
|
||||
app.add_config_value("llms_txt_code_files", [], "env")
|
||||
app.add_config_value("llms_txt_code_base_path", None, "env")
|
||||
|
||||
# Connect to Sphinx events
|
||||
app.connect("doctree-resolved", doctree_resolved)
|
||||
app.connect("build-finished", build_finished)
|
||||
def builder_inited(app):
|
||||
"""Used to limit what builders are allowed to run the extension."""
|
||||
|
||||
# Reset manager and root paragraph for each build
|
||||
global _manager, _root_first_paragraph
|
||||
_manager = LLMSFullManager()
|
||||
_root_first_paragraph = ""
|
||||
allowed_builders = ["html", "dirhtml"]
|
||||
if hasattr(app, "builder") and app.builder.name in allowed_builders:
|
||||
# Reset manager and root paragraph for each build
|
||||
global _manager, _root_first_paragraph
|
||||
_manager = LLMSFullManager()
|
||||
_root_first_paragraph = ""
|
||||
|
||||
app.connect("doctree-resolved", doctree_resolved)
|
||||
app.connect("build-finished", build_finished)
|
||||
|
||||
app.connect("builder-inited", builder_inited)
|
||||
|
||||
return {
|
||||
"version": __version__,
|
||||
|
||||
@@ -3,7 +3,7 @@ Document collector module for sphinx-llms-txt.
|
||||
"""
|
||||
|
||||
import fnmatch
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
from typing import Any, Dict, List, Tuple
|
||||
|
||||
from sphinx.environment import BuildEnvironment
|
||||
from sphinx.util import logging
|
||||
@@ -16,8 +16,8 @@ class DocumentCollector:
|
||||
|
||||
def __init__(self):
|
||||
self.page_titles: Dict[str, str] = {}
|
||||
self.master_doc: Optional[str] = None
|
||||
self.env: Optional[BuildEnvironment] = None
|
||||
self.master_doc: str = None
|
||||
self.env: BuildEnvironment = None
|
||||
self.config: Dict[str, Any] = {}
|
||||
self.app = None
|
||||
|
||||
@@ -60,7 +60,7 @@ class DocumentCollector:
|
||||
else:
|
||||
return [source_suffix] # String format
|
||||
|
||||
def _get_docname_suffix(self, docname: str, sources_dir) -> Optional[str]:
|
||||
def _get_docname_suffix(self, docname: str, sources_dir) -> str:
|
||||
"""
|
||||
Determine the source suffix for a given docname by checking which
|
||||
file exists.
|
||||
@@ -102,7 +102,7 @@ class DocumentCollector:
|
||||
|
||||
return None
|
||||
|
||||
def get_page_order(self, sources_dir=None) -> List[Tuple[str, Optional[str]]]:
|
||||
def get_page_order(self, sources_dir=None) -> List[Tuple[str, str]]:
|
||||
"""Get the correct page order from the toctree structure.
|
||||
|
||||
Args:
|
||||
@@ -114,7 +114,7 @@ class DocumentCollector:
|
||||
if not self.env or not self.master_doc:
|
||||
return []
|
||||
|
||||
page_order: List[Tuple[str, Optional[str]]] = []
|
||||
page_order = []
|
||||
visited = set()
|
||||
|
||||
def collect_from_toctree(docname: str):
|
||||
@@ -126,7 +126,7 @@ class DocumentCollector:
|
||||
|
||||
# Add the current document with its suffix
|
||||
if docname not in [doc for doc, _ in page_order]:
|
||||
suffix: Optional[str] = None
|
||||
suffix = None
|
||||
if sources_dir:
|
||||
suffix = self._get_docname_suffix(docname, sources_dir)
|
||||
page_order.append((docname, suffix))
|
||||
@@ -135,21 +135,18 @@ class DocumentCollector:
|
||||
try:
|
||||
# Look for toctree_includes which contains the direct children
|
||||
if (
|
||||
self.env
|
||||
and hasattr(self.env, "toctree_includes")
|
||||
hasattr(self.env, "toctree_includes")
|
||||
and docname in self.env.toctree_includes
|
||||
):
|
||||
for child_docname in self.env.toctree_includes[docname]:
|
||||
collect_from_toctree(str(child_docname))
|
||||
collect_from_toctree(child_docname)
|
||||
# Try to use dependencies to find related documents
|
||||
elif (
|
||||
self.env
|
||||
and hasattr(self.env, "dependencies")
|
||||
hasattr(self.env, "dependencies")
|
||||
and docname in self.env.dependencies
|
||||
):
|
||||
# Extract the dependent documents from the dependencies dict
|
||||
for child_docname_obj in self.env.dependencies[docname]:
|
||||
child_docname = str(child_docname_obj)
|
||||
for child_docname in self.env.dependencies[docname]:
|
||||
# Only add documents actually in the document set
|
||||
if (
|
||||
hasattr(self.env, "all_docs")
|
||||
@@ -157,11 +154,7 @@ class DocumentCollector:
|
||||
):
|
||||
collect_from_toctree(child_docname)
|
||||
# Fallback to titles or other available references
|
||||
elif (
|
||||
self.env
|
||||
and hasattr(self.env, "titles")
|
||||
and hasattr(self.env, "all_docs")
|
||||
):
|
||||
elif hasattr(self.env, "titles") and hasattr(self.env, "all_docs"):
|
||||
# Get all document names
|
||||
all_docnames = list(self.env.all_docs.keys())
|
||||
|
||||
@@ -192,7 +185,7 @@ class DocumentCollector:
|
||||
]
|
||||
)
|
||||
for docname in remaining:
|
||||
suffix: Optional[str] = None
|
||||
suffix = None
|
||||
if sources_dir:
|
||||
suffix = self._get_docname_suffix(docname, sources_dir)
|
||||
page_order.append((docname, suffix))
|
||||
@@ -200,8 +193,8 @@ class DocumentCollector:
|
||||
return page_order
|
||||
|
||||
def filter_excluded_pages(
|
||||
self, page_order: List[Tuple[str, Optional[str]]]
|
||||
) -> List[Tuple[str, Optional[str]]]:
|
||||
self, page_order: List[Tuple[str, str]]
|
||||
) -> List[Tuple[str, str]]:
|
||||
"""Filter out excluded pages from the page order."""
|
||||
exclude_patterns = self.config.get("llms_txt_exclude")
|
||||
if exclude_patterns:
|
||||
|
||||
+47
-27
@@ -5,7 +5,7 @@ Main manager module for sphinx-llms-txt.
|
||||
import glob
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Tuple, Union, cast
|
||||
from typing import Any, Dict, List, Optional, Tuple, Union
|
||||
|
||||
from sphinx.application import Sphinx
|
||||
from sphinx.environment import BuildEnvironment
|
||||
@@ -150,8 +150,8 @@ class LLMSFullManager:
|
||||
self.ignored_pages.add(docname)
|
||||
|
||||
def _filter_ignored_pages(
|
||||
self, page_order: Union[List[str], List[Tuple[str, Optional[str]]]]
|
||||
) -> Union[List[str], List[Tuple[str, Optional[str]]]]:
|
||||
self, page_order: Union[List[str], List[Tuple[str, str]]]
|
||||
) -> Union[List[str], List[Tuple[str, str]]]:
|
||||
"""Filter out ignored pages from page_order."""
|
||||
filtered_pages = []
|
||||
for item in page_order:
|
||||
@@ -164,7 +164,7 @@ class LLMSFullManager:
|
||||
if docname not in self.ignored_pages:
|
||||
filtered_pages.append(item)
|
||||
|
||||
return cast(Union[List[str], List[Tuple[str, Optional[str]]]], filtered_pages)
|
||||
return filtered_pages
|
||||
|
||||
def set_config(self, config: Dict[str, Any]):
|
||||
"""Set configuration options."""
|
||||
@@ -197,7 +197,6 @@ class LLMSFullManager:
|
||||
possible_sources = [
|
||||
Path(outdir) / "_sources",
|
||||
Path(outdir) / "html" / "_sources",
|
||||
Path(outdir) / "singlehtml" / "_sources",
|
||||
]
|
||||
|
||||
for path in possible_sources:
|
||||
@@ -205,27 +204,45 @@ class LLMSFullManager:
|
||||
sources_dir = path
|
||||
break
|
||||
|
||||
if not sources_dir:
|
||||
logger.warning(
|
||||
"Could not find _sources directory, skipping llms-full creation"
|
||||
)
|
||||
return
|
||||
|
||||
# Get the correct page order with source suffixes
|
||||
# Get the correct page order (with or without source suffixes)
|
||||
page_order = self.collector.get_page_order(sources_dir)
|
||||
|
||||
if not page_order:
|
||||
logger.warning(
|
||||
"Could not determine page order, skipping llms-full creation"
|
||||
)
|
||||
logger.warning("Could not determine page order, skipping file generation")
|
||||
return
|
||||
|
||||
# Apply exclusion filter if configured
|
||||
page_order = self.collector.filter_excluded_pages(page_order)
|
||||
|
||||
# Determine output file name and location
|
||||
# If no sources directory, only generate llms.txt and return early
|
||||
if not sources_dir:
|
||||
# Generate llms.txt if requested
|
||||
if self.config.get("llms_txt_file"):
|
||||
filtered_page_order = self._filter_ignored_pages(page_order)
|
||||
self.writer.write_verbose_info_to_file(
|
||||
filtered_page_order,
|
||||
self.collector.page_titles,
|
||||
0, # No line count since no llms-full.txt
|
||||
sources_dir,
|
||||
)
|
||||
|
||||
# Only warn if user explicitly wants llms-full.txt
|
||||
if self.config.get("llms_txt_full_file"):
|
||||
# Check if html_copy_source is False
|
||||
if self.app and not self.app.config.html_copy_source:
|
||||
logger.warning(
|
||||
"Could not find _sources directory, skipping llms-full.txt."
|
||||
"Set html_copy_source = True in conf.py to enable."
|
||||
)
|
||||
else:
|
||||
logger.warning(
|
||||
"Could not find _sources directory, skipping llms-full.txt"
|
||||
)
|
||||
return
|
||||
|
||||
# Determine output file name and location for llms-full.txt
|
||||
output_filename = self.config.get("llms_txt_full_filename")
|
||||
output_path = Path(outdir) / str(output_filename)
|
||||
output_path = Path(outdir) / output_filename
|
||||
|
||||
# Log discovered files and page order
|
||||
logger.debug(f"sphinx-llms-txt: Page order (after exclusion): {page_order}")
|
||||
@@ -286,7 +303,7 @@ class LLMSFullManager:
|
||||
content_parts = []
|
||||
|
||||
# Track code files for later processing
|
||||
code_file_parts: List[str] = []
|
||||
code_file_parts = []
|
||||
|
||||
# Count lines in code files (initially 0)
|
||||
code_files_line_count = 0
|
||||
@@ -365,7 +382,7 @@ class LLMSFullManager:
|
||||
if not (size_limit_exceeded and should_abort_early):
|
||||
# Get all source files in the _sources directory using configured suffixes
|
||||
source_suffixes = self._get_source_suffixes()
|
||||
all_source_files: List[Path] = []
|
||||
all_source_files = []
|
||||
for src_suffix in source_suffixes:
|
||||
# Avoid duplicate extensions when source_suffix == source_link_suffix
|
||||
if src_suffix == source_link_suffix:
|
||||
@@ -507,6 +524,7 @@ class LLMSFullManager:
|
||||
filtered_page_order,
|
||||
self.collector.page_titles,
|
||||
total_line_count,
|
||||
sources_dir,
|
||||
)
|
||||
return
|
||||
elif action == "note":
|
||||
@@ -520,6 +538,7 @@ class LLMSFullManager:
|
||||
filtered_page_order,
|
||||
self.collector.page_titles,
|
||||
total_line_count,
|
||||
sources_dir,
|
||||
)
|
||||
return
|
||||
elif action == "keep":
|
||||
@@ -538,7 +557,10 @@ class LLMSFullManager:
|
||||
if success and self.config.get("llms_txt_file"):
|
||||
filtered_page_order = self._filter_ignored_pages(page_order)
|
||||
self.writer.write_verbose_info_to_file(
|
||||
filtered_page_order, self.collector.page_titles, total_line_count
|
||||
filtered_page_order,
|
||||
self.collector.page_titles,
|
||||
total_line_count,
|
||||
sources_dir,
|
||||
)
|
||||
|
||||
def _read_source_file(self, file_path: Path, docname: str) -> Tuple[str, int]:
|
||||
@@ -735,9 +757,9 @@ class LLMSFullManager:
|
||||
title = Path(title_str[len(base_path) :])
|
||||
except ValueError:
|
||||
# File is not relative to srcdir, use filename
|
||||
title = Path(file_path.name)
|
||||
title = file_path.name
|
||||
else:
|
||||
title = Path(file_path.name)
|
||||
title = file_path.name
|
||||
|
||||
# Format as code block with equals underline
|
||||
title_str = str(title)
|
||||
@@ -769,9 +791,7 @@ class LLMSFullManager:
|
||||
|
||||
return code_parts, sorted(processed_files)
|
||||
|
||||
def _create_code_files_section_header(
|
||||
self, file_paths: Optional[List[Path]] = None
|
||||
) -> str:
|
||||
def _create_code_files_section_header(self, file_paths: List[Path] = None) -> str:
|
||||
"""Create the section header for source code files.
|
||||
|
||||
Args:
|
||||
@@ -819,7 +839,7 @@ class LLMSFullManager:
|
||||
return ""
|
||||
|
||||
# Convert to relative paths if possible and create tree structure
|
||||
tree_data: Dict[str, Any] = {}
|
||||
tree_data = {}
|
||||
|
||||
for file_path in sorted(file_paths):
|
||||
# Get relative path from source directory for display
|
||||
@@ -872,7 +892,7 @@ class LLMSFullManager:
|
||||
current[parts[-1]] = None # None indicates it's a file
|
||||
|
||||
# Convert tree structure to string representation
|
||||
lines: List[str] = []
|
||||
lines = []
|
||||
self._format_tree_node(tree_data, lines, "", True)
|
||||
|
||||
# Indent each line for reStructuredText code block
|
||||
|
||||
@@ -130,7 +130,7 @@ class DocumentProcessor:
|
||||
"""
|
||||
# Get the configured path directives to process
|
||||
default_path_directives = ["image", "figure"]
|
||||
custom_path_directives = self.config.get("llms_txt_directives") or []
|
||||
custom_path_directives = self.config.get("llms_txt_directives")
|
||||
path_directives = set(default_path_directives + custom_path_directives)
|
||||
|
||||
# Build the regex pattern to match all configured directives
|
||||
|
||||
+68
-12
@@ -3,7 +3,7 @@ File writer module for sphinx-llms-txt.
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
from typing import Any, Dict, List, Optional, Tuple, Union
|
||||
from typing import Any, Dict, List, Tuple, Union
|
||||
|
||||
from sphinx.application import Sphinx
|
||||
from sphinx.util import logging
|
||||
@@ -14,16 +14,47 @@ logger = logging.getLogger(__name__)
|
||||
class FileWriter:
|
||||
"""Handles writing processed content to output files."""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
config: Dict[str, Any],
|
||||
outdir: Optional[str] = None,
|
||||
app: Optional[Sphinx] = None,
|
||||
):
|
||||
def __init__(self, config: Dict[str, Any], outdir: str = None, app: Sphinx = None):
|
||||
self.config = config
|
||||
self.outdir = outdir
|
||||
self.app = app
|
||||
|
||||
def _resolve_uri_template(self, sources_dir: Path = None) -> str:
|
||||
"""Resolve which URI template to use based on configuration and sources_dir.
|
||||
|
||||
Args:
|
||||
sources_dir: Path to _sources directory (None if not found)
|
||||
|
||||
Returns:
|
||||
The template string to use for generating URIs
|
||||
"""
|
||||
# If custom template exists
|
||||
custom_template = self.config.get("llms_txt_uri_template")
|
||||
|
||||
if custom_template:
|
||||
# Validate user's template by checking for valid variable names
|
||||
try:
|
||||
# Try formatting with test valid values to validate syntax
|
||||
test_values = {
|
||||
"base_url": "http://example.com/",
|
||||
"docname": "test",
|
||||
"suffix": ".rst",
|
||||
"sourcelink_suffix": ".txt",
|
||||
}
|
||||
custom_template.format(**test_values)
|
||||
return custom_template
|
||||
except (KeyError, ValueError) as e:
|
||||
logger.warning(
|
||||
f"sphinx-llms-txt: Invalid llms_txt_uri_template: {e}. "
|
||||
f"Falling back to default."
|
||||
)
|
||||
|
||||
# Else, use one of the default templates
|
||||
if sources_dir:
|
||||
return "{base_url}_sources/{docname}{suffix}{sourcelink_suffix}"
|
||||
else:
|
||||
return "{base_url}{docname}.html"
|
||||
|
||||
def write_combined_file(
|
||||
self, content_parts: List[str], output_path: Path, total_line_count: int
|
||||
) -> bool:
|
||||
@@ -52,9 +83,10 @@ class FileWriter:
|
||||
|
||||
def write_verbose_info_to_file(
|
||||
self,
|
||||
page_order: Union[List[str], List[Tuple[str, Optional[str]]]],
|
||||
page_order: Union[List[str], List[Tuple[str, str]]],
|
||||
page_titles: Dict[str, str],
|
||||
total_line_count: int = 0,
|
||||
sources_dir: Path = None,
|
||||
) -> bool:
|
||||
"""Write summary information to the llms.txt file.
|
||||
|
||||
@@ -62,6 +94,7 @@ class FileWriter:
|
||||
page_order: Ordered list of document names or (docname, suffix) tuples
|
||||
page_titles: Dictionary mapping docnames to titles
|
||||
total_line_count: Total number of lines in the combined content
|
||||
sources_dir: Path to _sources directory (None if not found)
|
||||
|
||||
Returns:
|
||||
True if successful, False otherwise
|
||||
@@ -72,13 +105,13 @@ class FileWriter:
|
||||
)
|
||||
return False
|
||||
|
||||
output_path = Path(self.outdir) / str(self.config.get("llms_txt_filename"))
|
||||
output_path = Path(self.outdir) / self.config.get("llms_txt_filename")
|
||||
try:
|
||||
with open(output_path, "w", encoding="utf-8") as f:
|
||||
project_name = "llms-txt Summary"
|
||||
# First priority: use title from config if available
|
||||
if self.config.get("llms_txt_title"):
|
||||
project_name = str(self.config.get("llms_txt_title"))
|
||||
project_name = self.config.get("llms_txt_title")
|
||||
# Second priority: use project name from Sphinx app if available
|
||||
elif (
|
||||
self.app
|
||||
@@ -107,14 +140,37 @@ class FileWriter:
|
||||
if not base_url.endswith("/"):
|
||||
base_url += "/"
|
||||
|
||||
# Get sourcelink suffix from Sphinx config
|
||||
sourcelink_suffix = ""
|
||||
if self.app and hasattr(self.app.config, "html_sourcelink_suffix"):
|
||||
sourcelink_suffix = self.app.config.html_sourcelink_suffix
|
||||
# Handle empty string case specially
|
||||
if sourcelink_suffix == "":
|
||||
sourcelink_suffix = "" # Keep it empty
|
||||
elif not sourcelink_suffix.startswith("."):
|
||||
sourcelink_suffix = "." + sourcelink_suffix
|
||||
|
||||
# Resolve which template to use
|
||||
uri_template = self._resolve_uri_template(sources_dir)
|
||||
|
||||
for item in page_order:
|
||||
# Handle both old format (str) and new format (tuple)
|
||||
if isinstance(item, tuple):
|
||||
docname, _ = item
|
||||
docname, suffix = item
|
||||
else:
|
||||
docname = item
|
||||
suffix = None
|
||||
|
||||
title = page_titles.get(docname, docname)
|
||||
f.write(f"- [{title}]({base_url}{docname}.html)\n")
|
||||
|
||||
uri = uri_template.format(
|
||||
base_url=base_url,
|
||||
docname=docname,
|
||||
suffix=suffix or "",
|
||||
sourcelink_suffix=sourcelink_suffix,
|
||||
)
|
||||
|
||||
f.write(f"- [{title}]({uri})\n")
|
||||
|
||||
logger.info(f"sphinx-llms-txt: created {output_path}")
|
||||
return True
|
||||
|
||||
@@ -41,6 +41,42 @@ def test_setup_returns_valid_dict():
|
||||
assert "parallel_write_safe" in result
|
||||
|
||||
|
||||
def test_builder_inited_with_disallowed_builder():
|
||||
"""Test that disallowed builders do not trigger extension setup."""
|
||||
import sphinx_llms_txt
|
||||
|
||||
# Reset global state
|
||||
sphinx_llms_txt._manager = sphinx_llms_txt.LLMSFullManager()
|
||||
sphinx_llms_txt._root_first_paragraph = ""
|
||||
|
||||
# Mock a Sphinx app with a disallowed builder
|
||||
class MockBuilder:
|
||||
name = "text" # Not in allowed list
|
||||
|
||||
class MockApp:
|
||||
def __init__(self):
|
||||
self.config_values = {}
|
||||
self.connections = {}
|
||||
self.builder = MockBuilder()
|
||||
|
||||
def add_config_value(self, name, default, rebuild):
|
||||
self.config_values[name] = (default, rebuild)
|
||||
|
||||
def connect(self, event, handler):
|
||||
self.connections[event] = handler
|
||||
|
||||
app = MockApp()
|
||||
setup(app)
|
||||
|
||||
# Trigger builder-inited
|
||||
builder_inited_handler = app.connections["builder-inited"]
|
||||
builder_inited_handler(app)
|
||||
|
||||
# With disallowed builder, other events should NOT be connected
|
||||
assert "doctree-resolved" not in app.connections
|
||||
assert "build-finished" not in app.connections
|
||||
|
||||
|
||||
def test_document_collector_initialization():
|
||||
"""Test initialization of DocumentCollector."""
|
||||
collector = DocumentCollector()
|
||||
@@ -758,6 +794,7 @@ def test_summary_default_uses_first_paragraph():
|
||||
llms_txt_summary = None # Not configured
|
||||
llms_txt_file = True
|
||||
llms_txt_filename = "llms.txt"
|
||||
llms_txt_uri_template = None
|
||||
llms_txt_title = None
|
||||
llms_txt_full_file = True
|
||||
llms_txt_full_filename = "llms-full.txt"
|
||||
@@ -995,3 +1032,128 @@ def test_code_files_ignored_patterns(tmp_path, caplog):
|
||||
assert (
|
||||
"Code file pattern 'docs/**/*.rst' ignored." in captured_warnings[0]
|
||||
), f"Warning message should contain expected text. Got: {captured_warnings[0]}"
|
||||
|
||||
|
||||
def test_llms_txt_generated_without_sources_dir(tmp_path):
|
||||
"""Test that llms.txt is generated even when _sources directory doesn't exist."""
|
||||
|
||||
from sphinx_llms_txt.manager import LLMSFullManager
|
||||
|
||||
# Create manager
|
||||
manager = LLMSFullManager()
|
||||
|
||||
# Set config to enable llms.txt
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
"llms_txt_full_file": True,
|
||||
"llms_txt_full_filename": "llms-full.txt",
|
||||
"llms_txt_exclude": [],
|
||||
"llms_txt_directives": [],
|
||||
}
|
||||
manager.set_config(config)
|
||||
|
||||
# Create directories (but no _sources)
|
||||
outdir = tmp_path / "build"
|
||||
srcdir = tmp_path / "source"
|
||||
outdir.mkdir()
|
||||
srcdir.mkdir()
|
||||
|
||||
# Mock env with documents
|
||||
class MockEnv:
|
||||
all_docs = {"index": None, "about": None}
|
||||
titles = {
|
||||
"index": type("TitleNode", (), {"astext": lambda self: "Home"})(),
|
||||
"about": type("TitleNode", (), {"astext": lambda self: "About"})(),
|
||||
}
|
||||
toctree_includes = {"index": ["about"]}
|
||||
|
||||
manager.set_env(MockEnv())
|
||||
manager.set_master_doc("index")
|
||||
|
||||
# Update page titles directly in the collector
|
||||
manager.update_page_title("index", "Home")
|
||||
manager.update_page_title("about", "About")
|
||||
|
||||
# Call combine_sources - should generate llms.txt even without _sources
|
||||
manager.combine_sources(str(outdir), str(srcdir))
|
||||
|
||||
# Verify llms.txt was created
|
||||
llms_txt = outdir / "llms.txt"
|
||||
assert llms_txt.exists(), "llms.txt should be generated even without _sources"
|
||||
|
||||
# Verify llms-full.txt was NOT created (since no _sources)
|
||||
llms_full_txt = outdir / "llms-full.txt"
|
||||
assert (
|
||||
not llms_full_txt.exists()
|
||||
), "llms-full.txt should not be generated without _sources"
|
||||
|
||||
# Read llms.txt and verify it has content
|
||||
with open(llms_txt, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Should contain page titles and links
|
||||
assert "Home" in content
|
||||
assert "About" in content
|
||||
assert "index.html" in content
|
||||
assert "about.html" in content
|
||||
|
||||
|
||||
def test_llms_txt_no_warning_when_full_file_disabled(tmp_path, caplog):
|
||||
"""
|
||||
Test that no warning is logged when llms_txt_full_file=False and
|
||||
_sources doesn't exist.
|
||||
"""
|
||||
from unittest.mock import patch
|
||||
|
||||
from sphinx_llms_txt.manager import LLMSFullManager
|
||||
|
||||
# Create manager
|
||||
manager = LLMSFullManager()
|
||||
|
||||
# Set config with llms_txt_full_file=False
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
"llms_txt_full_file": False, # User doesn't want llms-full.txt
|
||||
"llms_txt_full_filename": "llms-full.txt",
|
||||
"llms_txt_exclude": [],
|
||||
"llms_txt_directives": [],
|
||||
}
|
||||
manager.set_config(config)
|
||||
|
||||
# Create directories (but no _sources)
|
||||
outdir = tmp_path / "build"
|
||||
srcdir = tmp_path / "source"
|
||||
outdir.mkdir()
|
||||
srcdir.mkdir()
|
||||
|
||||
# Mock env with documents
|
||||
class MockEnv:
|
||||
all_docs = {"index": None}
|
||||
titles = {"index": type("TitleNode", (), {"astext": lambda self: "Home"})()}
|
||||
toctree_includes = {"index": []}
|
||||
|
||||
manager.set_env(MockEnv())
|
||||
manager.set_master_doc("index")
|
||||
manager.update_page_title("index", "Home")
|
||||
|
||||
# Capture warnings
|
||||
captured_warnings = []
|
||||
|
||||
def capture_warning(message, *args, **kwargs):
|
||||
if "_sources" in str(message):
|
||||
captured_warnings.append(message)
|
||||
|
||||
with patch("sphinx_llms_txt.manager.logger.warning", side_effect=capture_warning):
|
||||
# Call combine_sources
|
||||
manager.combine_sources(str(outdir), str(srcdir))
|
||||
|
||||
# Verify NO warning was logged since llms_txt_full_file=False
|
||||
assert (
|
||||
len(captured_warnings) == 0
|
||||
), "No warning should be logged when llms_txt_full_file=False"
|
||||
|
||||
# Verify llms.txt was still created
|
||||
llms_txt = outdir / "llms.txt"
|
||||
assert llms_txt.exists()
|
||||
|
||||
@@ -0,0 +1,175 @@
|
||||
"""Test URI template functionality for llms.txt links."""
|
||||
|
||||
from sphinx_llms_txt import FileWriter
|
||||
|
||||
|
||||
def test_uri_template_with_sources_dir(tmp_path):
|
||||
"""Test that default template uses _sources links when sources_dir exists."""
|
||||
build_dir = tmp_path / "build"
|
||||
build_dir.mkdir()
|
||||
|
||||
# Create _sources directory to simulate its existence
|
||||
sources_dir = build_dir / "_sources"
|
||||
sources_dir.mkdir()
|
||||
|
||||
# Mock app with html_sourcelink_suffix
|
||||
class MockApp:
|
||||
class Config:
|
||||
html_sourcelink_suffix = ".txt"
|
||||
|
||||
config = Config()
|
||||
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
"llms_txt_uri_template": (
|
||||
"{base_url}_sources/{docname}{suffix}{sourcelink_suffix}"
|
||||
),
|
||||
"html_baseurl": "https://example.com",
|
||||
}
|
||||
writer = FileWriter(config, str(build_dir), MockApp())
|
||||
|
||||
page_titles = {
|
||||
"index": "Home Page",
|
||||
"about": "About Us",
|
||||
}
|
||||
|
||||
# Page order with suffixes (simulating _sources files exist)
|
||||
page_order = [("index", ".rst"), ("about", ".md")]
|
||||
|
||||
writer.write_verbose_info_to_file(page_order, page_titles, 0, sources_dir)
|
||||
|
||||
# Check that the file was created
|
||||
verbose_file = build_dir / "llms.txt"
|
||||
assert verbose_file.exists()
|
||||
|
||||
# Read the file content
|
||||
with open(verbose_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Should link to _sources files
|
||||
assert "- [Home Page](https://example.com/_sources/index.rst.txt)" in content
|
||||
assert "- [About Us](https://example.com/_sources/about.md.txt)" in content
|
||||
|
||||
|
||||
def test_uri_template_without_sources_dir(tmp_path):
|
||||
"""
|
||||
Test that HTML template is used when sources_dir doesn't exist and no custom
|
||||
template.
|
||||
"""
|
||||
build_dir = tmp_path / "build"
|
||||
build_dir.mkdir()
|
||||
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
# No custom template set
|
||||
"html_baseurl": "https://example.com",
|
||||
}
|
||||
writer = FileWriter(config, str(build_dir))
|
||||
|
||||
page_titles = {
|
||||
"index": "Home Page",
|
||||
"about": "About Us",
|
||||
}
|
||||
|
||||
# Page order without suffixes (simulating no _sources)
|
||||
page_order = [("index", None), ("about", None)]
|
||||
|
||||
# Pass None for sources_dir to simulate it doesn't exist
|
||||
writer.write_verbose_info_to_file(page_order, page_titles, 0, None)
|
||||
|
||||
# Check that the file was created
|
||||
verbose_file = build_dir / "llms.txt"
|
||||
assert verbose_file.exists()
|
||||
|
||||
# Read the file content
|
||||
with open(verbose_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Should fallback to HTML links
|
||||
assert "- [Home Page](https://example.com/index.html)" in content
|
||||
assert "- [About Us](https://example.com/about.html)" in content
|
||||
|
||||
|
||||
def test_uri_template_custom(tmp_path):
|
||||
"""Test that custom URI template works correctly."""
|
||||
build_dir = tmp_path / "build"
|
||||
build_dir.mkdir()
|
||||
|
||||
sources_dir = build_dir / "_sources"
|
||||
sources_dir.mkdir()
|
||||
|
||||
# Mock app with html_sourcelink_suffix
|
||||
class MockApp:
|
||||
class Config:
|
||||
html_sourcelink_suffix = ".txt"
|
||||
|
||||
config = Config()
|
||||
|
||||
# Custom template that uses different path
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
"llms_txt_uri_template": "{base_url}raw/{docname}{suffix}",
|
||||
"html_baseurl": "https://example.com/",
|
||||
}
|
||||
writer = FileWriter(config, str(build_dir), MockApp())
|
||||
|
||||
page_titles = {
|
||||
"index": "Home Page",
|
||||
}
|
||||
|
||||
page_order = [("index", ".rst")]
|
||||
|
||||
writer.write_verbose_info_to_file(page_order, page_titles, 0, sources_dir)
|
||||
|
||||
verbose_file = build_dir / "llms.txt"
|
||||
with open(verbose_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Should use custom template
|
||||
assert "- [Home Page](https://example.com/raw/index.rst)" in content
|
||||
|
||||
|
||||
def test_uri_template_invalid_fallback(tmp_path):
|
||||
"""
|
||||
Test that invalid template falls back to default sources template when
|
||||
sources_dir exists.
|
||||
"""
|
||||
build_dir = tmp_path / "build"
|
||||
build_dir.mkdir()
|
||||
|
||||
sources_dir = build_dir / "_sources"
|
||||
sources_dir.mkdir()
|
||||
|
||||
# Mock app with html_sourcelink_suffix
|
||||
class MockApp:
|
||||
class Config:
|
||||
html_sourcelink_suffix = ".txt"
|
||||
|
||||
config = Config()
|
||||
|
||||
# Invalid template with typo in variable name
|
||||
config = {
|
||||
"llms_txt_file": True,
|
||||
"llms_txt_filename": "llms.txt",
|
||||
"llms_txt_uri_template": "{base_urll}/{docname}",
|
||||
"html_baseurl": "https://example.com",
|
||||
}
|
||||
writer = FileWriter(config, str(build_dir), MockApp())
|
||||
|
||||
page_titles = {
|
||||
"index": "Home Page",
|
||||
}
|
||||
|
||||
page_order = [("index", ".rst")]
|
||||
|
||||
writer.write_verbose_info_to_file(page_order, page_titles, 0, sources_dir)
|
||||
|
||||
verbose_file = build_dir / "llms.txt"
|
||||
with open(verbose_file, "r", encoding="utf-8") as f:
|
||||
content = f.read()
|
||||
|
||||
# Should fallback to default sources template
|
||||
assert "- [Home Page](https://example.com/_sources/index.rst.txt)" in content
|
||||
Reference in New Issue
Block a user