Skip to content

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

Merged
spencer-tb merged 2 commits into
mainfrom
reduce-search-index-size
Mar 10, 2025
Merged

fix(docs,ci): don't include function pages in site search index#1292
spencer-tb merged 2 commits into
mainfrom
reduce-search-index-size

Conversation

@danceratopz

@danceratopz danceratopz commented Mar 10, 2025

Copy link
Copy Markdown
Member

🗒️ 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

@spencer-tb spencer-tb left a comment

Copy link
Copy Markdown
Collaborator

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
@spencer-tb spencer-tb deleted the reduce-search-index-size branch March 10, 2025 09:18
danceratopz added a commit that referenced this pull request Apr 1, 2025
felix314159 pushed a commit to felix314159/execution-spec-tests that referenced this pull request May 16, 2025
…reum#1292)

* chore(docs): don't include function pages in site search index ethereum#1291

* docs: update changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope:ci Scope: Continuous Integration scope:docs Scope: Documentation type:bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(docs,ci): gh-pages fail to deply; search index > 100 MB

2 participants