Skip to content

docs: add sphinx llm.txt plugin - #2297

Draft
atravitz wants to merge 1 commit into
mainfrom
docs/add_llm.txt
Draft

atravitz wants to merge 1 commit into
mainfrom
docs/add_llm.txt

Conversation

@atravitz

@atravitz atravitz commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Description

we've received feedback that users use LLMs to access our docs, and that they generally work well but sometimes do not find information. This seems like a way to make parsing more direct without degrading the human readability.

LLM / AI generated code disclosure

LLMs or other AI-powered tools (beyond simple IDE use cases) were used in this contribution:

  • No
  • Yes: [If yes, please provide details here]

Checklist

  • Read the AI Policy and filled in the AI-generated code disclosure.
  • Adhered to the contribution guidelines
  • All new code is appropriately documented (user-facing code must have complete docstrings).
  • Ran pre-commit: you can run pre-commit locally or comment on this PR with pre-commit.ci autofix.
  • Added a news entry, or the changes are not user-facing.

Manual Tests: these are slow so don't need to be run every commit, only before merging and when relevant changes are made (generally at reviewer-discretion).

Developers certificate of origin

@codecov

codecov Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.45%. Comparing base (75562a6) to head (c6216f8).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2297      +/-   ##
==========================================
- Coverage   95.14%   90.45%   -4.69%     
==========================================
  Files         227      227              
  Lines       22477    22477              
==========================================
- Hits        21385    20332    -1053     
- Misses       1092     2145    +1053     
Flag Coverage Δ
fast-tests 90.45% <ø> (?)
slow-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@atravitz
atravitz marked this pull request as ready for review October 22, 2026 22:33
@atravitz
atravitz marked this pull request as draft October 22, 2026 22:33
@atravitz atravitz self-assigned this Oct 23, 2026
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