feat: Add llm_friendly_source option for LLM-compatible source rendering #300
+112
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new
llm_friendly_source
configuration option that addresses the compatibility issue between mkdocstrings source code rendering and LLM-focused tools like mkdocs-llmstxt.Problem
When using
show_source: true
with mkdocstrings-python, the mkdocs-llmstxt plugin generates suboptimal output inllms-full.txt
files. Instead of clean, readable Python code blocks, source code gets converted into confusing table format with line numbers and compressed code.Solution
Added a new boolean configuration option
llm_friendly_source
that:False
)show_source
optionChanges
llm_friendly_source: bool = False
toPythonInputOptions
Usage
Before vs After
Before (Traditional - problematic for LLM tools):
After (LLM-friendly):
Test Plan
Fixes #299
🤖 Generated with Claude Code