Generate llms output in one Sphinx build - #136
Merged
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
timkpaine
marked this pull request as ready for review
August 6, 2026 15:49
Contributor
Test Results83 tests ±0 83 ✅ ±0 24s ⏱️ -13s Results for commit 84c7c24. ± Comparison against base commit 290e83d. This pull request removes 1 and adds 1 tests. Note that renamed tests count towards both. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #136 +/- ##
==========================================
- Coverage 83.48% 80.65% -2.84%
==========================================
Files 15 15
Lines 1823 1892 +69
Branches 197 203 +6
==========================================
+ Hits 1522 1526 +4
- Misses 250 315 +65
Partials 51 51 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Description
Generate llms.txt output from Yardang's Sphinx extension during the existing HTML build instead of launching a second Sphinx process. The extension renders reachable resolved doctrees as Markdown, rewrites internal links to
.html.md, and writesllms.txtplus optionalllms-full.txtafter a successful build.Promote
sphinx-markdown-builderto a core dependency and remove the now-obsoletellmsextra. Its only additional runtime dependency beyond Sphinx and Docutils istabulate. Keep the explicityardang-llmsbuilder available for direct Sphinx use.Type of Change
Checklist
make lint)make test)Focused llms tests pass, 81 unaffected tests pass, package metadata validation passes, and an isolated project docs build produces HTML and all llms outputs. Local root
make testcould not complete because an unrelated untrackedbase/symlink was discovered as 9,220 Sphinx sources; CI runs from a clean checkout.