Skip to content

index object descriptions as their own search records - #16

Merged
timkpaine merged 2 commits into
python-project-templates:mainfrom
emilybarrettp72:desc_dredge
Oct 22, 2026
Merged

timkpaine merged 2 commits into
python-project-templates:mainfrom
emilybarrettp72:desc_dredge

Conversation

@emilybarrettp72

Copy link
Copy Markdown
Contributor
  • api reference pages are mostly autodoc objects with few headings, so everything past the first 1200 chars of a section was unsearchable
  • each anchored object description (class, method, field, enum member, c/cpp, options) now gets its own record, linked to its anchor and named by its qualified name
  • section text leaves out objects that have their own record, so nothing is indexed twice; :no-index: objects stay in section text
  • overloads keep every signature's text
  • known tradeoff: short object records can outrank prose sections on common words, could dampen object scoring in the engine as a follow up

emilybarrettp72 and others added 2 commits October 22, 2026 11:51
@codecov

codecov Bot commented Oct 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 94.04762% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.71%. Comparing base (eb0d151) to head (e34ab3d).

Files with missing lines Patch % Lines
sphinx_searchlite/_index.py 86.48% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #16      +/-   ##
==========================================
- Coverage   95.12%   94.71%   -0.41%     
==========================================
  Files           3        3              
  Lines         164      246      +82     
  Branches       10       17       +7     
==========================================
+ Hits          156      233      +77     
- Misses          4        9       +5     
  Partials        4        4              

☔ 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 101173b into python-project-templates:main Oct 22, 2026
1 of 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.

2 participants