Skip to content

📚 DOCS: add sphinx-ai-index to sphinx docs builder#1671

Merged
chrisjsewell merged 2 commits intomasterfrom
feat/1334-build-sphinx-ai-index
Mar 16, 2026
Merged

📚 DOCS: add sphinx-ai-index to sphinx docs builder#1671
chrisjsewell merged 2 commits intomasterfrom
feat/1334-build-sphinx-ai-index

Conversation

@Felix-Ruh
Copy link
Copy Markdown
Contributor

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.

@Felix-Ruh Felix-Ruh requested a review from chrisjsewell March 16, 2026 13:08
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.88%. Comparing base (4e10030) to head (b466240).
⚠️ Report is 260 commits behind head on master.

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     
Flag Coverage Δ
pytests 88.88% <ø> (+2.00%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 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.

@chrisjsewell chrisjsewell changed the title ✨ NEW: add sphinx-ai-index to sphinx docs builder 📚 DOCS: add sphinx-ai-index to sphinx docs builder Mar 16, 2026
@chrisjsewell chrisjsewell merged commit f77ac0a into master Mar 16, 2026
25 checks passed
@chrisjsewell chrisjsewell deleted the feat/1334-build-sphinx-ai-index branch March 16, 2026 13:48
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.

2 participants