Skip to content

feat(llms): add llms.txt generation via sphinx-llm#117

Merged
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/llms
Jun 29, 2026
Merged

feat(llms): add llms.txt generation via sphinx-llm#117
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/llms

Conversation

@timkpaine

Copy link
Copy Markdown
Member

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

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

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.55%. Comparing base (f066aeb) to head (e13dbb5).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@timkpaine timkpaine merged commit a6fda9c into python-project-templates:main Jun 29, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant