Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(docs,ci): don't include function pages in site search index #1292

Merged
merged 2 commits into from
Mar 10, 2025
Merged

fix(docs,ci): don't include function pages in site search index #1292

merged 2 commits into from
Mar 10, 2025
+11 −0

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Mar 10, 2025 •
edited
Loading

🗒️ Description

Fixes #1291 by removing the automatically generated test function pages from the mkdocs-material search index.

This change reduces the size of site/search/search_index.json from ~123 Mb to ~2 Mb.

🔗 Related Issues

Fixes:

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

@danceratopz danceratopz added type:bug Something isn't working scope:docs Scope: Documentation scope:ci Scope: Continuous Integration labels Mar 10, 2025
@danceratopz danceratopz self-assigned this Mar 10, 2025
@danceratopz danceratopz mentioned this pull request Mar 10, 2025
Closed
spencer-tb
spencer-tb approved these changes Mar 10, 2025
View reviewed changes
Copy link
Collaborator

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks :)

@spencer-tb spencer-tb merged commit 9528ea1 into main Mar 10, 2025
21 checks passed
@spencer-tb spencer-tb deleted the reduce-search-index-size branch March 10, 2025 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spencer-tb spencer-tb spencer-tb approved these changes

Assignees

@danceratopz danceratopz

Labels
scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

bug(docs,ci): gh-pages fail to deply; search index > 100 MB
2 participants
@danceratopz @spencer-tb