feat: Add llm_friendly_source option for LLM-compatible source rendering#300
Closed
S1M0N38 wants to merge 1 commit intomkdocstrings:mainfrom
S1M0N38:main
Closed
feat: Add llm_friendly_source option for LLM-compatible source rendering#300S1M0N38 wants to merge 1 commit intomkdocstrings:mainfrom S1M0N38:main
S1M0N38 wants to merge 1 commit intomkdocstrings:mainfrom
S1M0N38:main
Conversation
Add a new configuration option `llm_friendly_source` that renders source code in a format more compatible with LLM-focused tools like mkdocs-llmstxt. When enabled along with `show_source`, this option: - Removes line numbers from source code blocks - Uses simple markdown-style code blocks instead of complex HTML tables - Improves compatibility with tools that convert documentation to LLM-friendly formats Changes: - Add `llm_friendly_source: bool = False` config option in PythonInputOptions - Update function and class templates to support LLM-friendly rendering - Add comprehensive documentation with usage examples - Add tests to verify both traditional and LLM-friendly rendering work correctly Fixes #299 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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_sourceconfiguration option that addresses the compatibility issue between mkdocstrings source code rendering and LLM-focused tools like mkdocs-llmstxt.Problem
When using
show_source: truewith mkdocstrings-python, the mkdocs-llmstxt plugin generates suboptimal output inllms-full.txtfiles. 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_sourcethat:False)show_sourceoptionChanges
llm_friendly_source: bool = FalsetoPythonInputOptionsUsage
Before vs After
Before (Traditional - problematic for LLM tools):
After (LLM-friendly):
Test Plan
Fixes #299
🤖 Generated with Claude Code