Skip to content

Commit 9528ea1

Browse files
authored
fix(docs,ci): don't include function pages in site search index (#1292)
* chore(docs): don't include function pages in site search index #1291 * docs: update changelog
1 parent 40b7a6c commit 9528ea1

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

docs/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The following changes may be potentially breaking (all clients were tested with
3232
- ✨ Improve the `uv run eest make test` interactive CLI to enable creation of new test modules within existing test sub-folders ([#1241](https://github.com/ethereum/execution-spec-tests/pull/1241)).
3333
- ✨ Update `mypy` to latest release `>=1.15.0,<1.16` ([#1209](https://github.com/ethereum/execution-spec-tests/pull/1209)).
3434
- 🐞 Bug fix for filling with EELS for certain Python versions due to an issue with CPython ([#1231](https://github.com/ethereum/execution-spec-tests/pull/1231)).
35+
- 🐞 Fix HTML site deployment due to the site's index file exceeding Github's max file size limit ([#1292](https://github.com/ethereum/execution-spec-tests/pull/1292)).
3536

3637
### 🧪 Test Cases
3738

docs/templates/function.md.j2

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
{% extends "base.md.j2" %}
22
{% block title %}
3+
---
4+
search:
5+
exclude: true
6+
---
7+
{#
8+
don't include function pages in the mkdocs-material site search index
9+
see https://github.com/ethereum/execution-spec-tests/issues/1291
10+
#}
11+
312
# `{{ title }}()`
413
{% endblock %}
514
{% block additional_content %}

whitelist.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@ GHSA
211211
git's
212212
github
213213
Github
214+
Github's
214215
glightbox
215216
globals
216217
go-ethereum's

0 commit comments

Comments
 (0)