Skip to content

Commit 5752b8a

Browse files
committed
migrate whitelist tool to ethereum_spec_tools, update markdown files, touch up whitelist, clean up tox
1 parent 24d4368 commit 5752b8a

File tree

5 files changed

+67
-76
lines changed

5 files changed

+67
-76
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/ethereum/execution-specs/badge)](https://www.gitpoap.io/gh/ethereum/execution-specs)
44
[![codecov](https://codecov.io/gh/ethereum/execution-specs/graph/badge.svg?token=0LQZO56RTM)](https://codecov.io/gh/ethereum/execution-specs)
5-
[![Python Specification](https://github.com/ethereum/execution-specs/actions/workflows/test.yaml/badge.svg)](https://github.com/ethereum/execution-specs/actions/workflows/test.yaml)
5+
[![Python Specification](https://github.com/ethereum/execution-specs/workflows/test.yaml/badge.svg)](https://github.com/ethereum/execution-specs/workflows/test.yaml)
66

77
## Description
88

@@ -67,16 +67,26 @@ The Ethereum specification is maintained as a Python library, for better integra
6767

6868
Requires Python 3.11+
6969

70-
### Building
70+
### Building Specification Doucumentation
7171

72-
Building the documentation is most easily done through [`tox`](https://tox.readthedocs.io/en/latest/):
72+
Building the spec documentation is most easily done through [`tox`](https://tox.readthedocs.io/en/latest/):
7373

7474
```bash
75-
uvx --with=tox-uv tox -e docs
75+
uvx --with=tox-uv tox -e spec-docs
7676
```
7777

7878
The path to the generated HTML will be printed to the console.
7979

80+
### Browsing Updated Documentation
81+
82+
To view the updated local documentation, run:
83+
84+
```bash
85+
uv run mkdocs serve
86+
```
87+
88+
then connect to `localhost:8000` in a browser
89+
8090
## License
8191

8292
The Ethereum Execution Layer Specification code is licensed under the [Creative Commons Zero v1.0 Universal](/execution-specs/LICENSE.md).

docs/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Test fixtures for use by clients are available for each release on the [Github r
2020

2121
### 📋 Misc
2222

23+
- 🐞 WELDed the EEST tox environments relevent to producing documentation into EELS. ([#1695](https://github.com/ethereum/execution-specs/pull/1659))
24+
- 🔀 Merged codespell dictionaries for EEST/EELS and added a new tool to cleanly add words to the whitelist while keeping it organized. ([#1695](https://github.com/ethereum/execution-specs/pull/1659))
25+
2326
### 🧪 Test Cases
2427

2528
- 🐞 Fix BALs opcode OOG test vectors by updating the Amsterdam commit hash in specs and validating appropriately on the testing side ([#2293](https://github.com/ethereum/execution-spec-tests/pull/2293)).

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,7 @@ ethereum-spec-sync = "ethereum_spec_tools.sync:main"
231231
ethereum-spec-new-fork = "ethereum_spec_tools.new_fork.cli:main"
232232
ethereum-spec-patch = "ethereum_spec_tools.patch_tool:main"
233233
ethereum-spec-evm = "ethereum_spec_tools.evm_tools:main"
234+
whitelist = "ethereum_spec_tools.whitelist:main"
234235

235236
[project.entry-points."docc.plugins"]
236237
"ethereum_spec_tools.docc.discover" = "ethereum_spec_tools.docc:EthereumDiscover"
@@ -392,10 +393,8 @@ skip = [ # Don't check these files/folders
392393
"*.coverage*",
393394
"__pycache__",
394395
".ruff_cache",
395-
"fixtures.*",
396396
"tests/fixtures",
397397
"tests/json_infra/fixtures",
398-
"eest_tests",
399398
"src/ethereum_spec_tools/evm_tools/t8n" # Temporary while being re-written
400399
]
401400
count = true # Display counts of errors

tox.ini

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ commands =
117117
--optimized \
118118
tests/json_infra
119119

120-
[testenv:doc]
120+
[testenv:spec-docs]
121121
basepython = python3
122122
extras = doc
123123
commands =
@@ -149,36 +149,15 @@ extras = docs
149149
package = editable
150150
commands = python -c "import packages.testing.src.execution_testing.cli.tox_helpers; packages.testing.src.execution_testing.cli.tox_helpers.markdownlint()"
151151

152-
[testenv:eest-docs]
153-
description = Alias that runs EEST documentation checks (spellcheck, markdownlint, mkdocs)
152+
[testenv:check-docs]
153+
description = Runs all documentation checks (spellcheck, markdownlint, mkdocs)
154154
extras =
155-
{[testenv:markdownlint]extras}
156-
{[testenv:mkdocs]extras}
157-
package = editable
158-
setenv =
159-
{[testenv:mkdocs]setenv}
160-
commands =
161-
{[testenv:st-spellcheck]commands}
162-
{[testenv:markdownlint]commands}
163-
{[testenv:mkdocs]commands}
164-
165-
[testenv:docs]
166-
description = Alias that runs all documentation checks (spellcheck, markdownlint, mkdocs)
167-
extras =
168-
{[testenv:markdownlint]extras}
169-
{[testenv:mkdocs]extras}
155+
{[testenv:test-docs]extras}
170156
doc
171157
package = editable
172158
setenv =
173-
{[testenv:mkdocs]setenv}
159+
{[testenv:test-docs]setenv}
174160
commands =
175161
codespell -I whitelist.txt docs
176162
{[testenv:markdownlint]commands}
177163
{[testenv:mkdocs]commands}
178-
{[testenv:doc]commands}
179-
180-
[testenv:whitelist]
181-
description = Add words to the whitelist
182-
skip_install = true
183-
allowlist_externals = python
184-
commands = python {toxinidir}/scripts/add_to_whitelist.py {posargs}

0 commit comments

Comments
 (0)