📚 DOCS: add sphinx-ai-index to sphinx docs builder#1671
Merged
chrisjsewell merged 2 commits intomasterfrom Mar 16, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1671 +/- ##
==========================================
+ Coverage 86.87% 88.88% +2.00%
==========================================
Files 56 71 +15
Lines 6532 10015 +3483
==========================================
+ Hits 5675 8902 +3227
- Misses 857 1113 +256
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
chrisjsewell
approved these changes
Mar 16, 2026
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.
This PR adds the sphinx-ai-index sphinx extension to the documentation extensions. This will automatically generate a ai_docs_index.json file, which serves as efficient retrieval interface for AI agents or other applications.
It also adds the ability to add an optional page-summary directive to a page, which will be added to this index, but will not be rendered into HTML.