feat(llms): add llms.txt generation via sphinx-llm#117
Merged
Conversation
Wire NVIDIA's sphinx-llm extension into the docs build so projects can emit llms.txt / llms-full.txt alongside the HTML output. - pyproject: add `llms` extra (sphinx-llm>=0.4.1) and enable it for yardang's own docs via [tool.yardang.llms] - build.py: load [tool.yardang.llms] config and pass use_llms plus the llms_txt_* passthrough options into the conf template - conf.py.j2: register the sphinx_llm.txt extension and emit llms_txt_* settings when enabled - tests: cover config loading, extension wiring, and default-off behaviour
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #117 +/- ##
==========================================
+ Coverage 82.66% 83.55% +0.88%
==========================================
Files 9 10 +1
Lines 1373 1447 +74
Branches 145 148 +3
==========================================
+ Hits 1135 1209 +74
Misses 198 198
Partials 40 40 ☔ 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.
Wire NVIDIA's sphinx-llm extension into the docs build so projects can emit llms.txt / llms-full.txt alongside the HTML output.
llmsextra (sphinx-llm>=0.4.1) and enable it for yardang's own docs via [tool.yardang.llms]