Skip to content

Commit f8c329a

Browse files
authored
Documentation: Add configuration file and python requirements to build Rtdio web page (#58)
* Add initial requirement file. * Add all python packages required to build on rtdio. * Fix broken link and remove unknowns from config. * Rename file. * Add readthedocs yaml config file. * Quick requirements file location fix.
1 parent f8a64cb commit f8c329a

File tree

4 files changed

+39
-4
lines changed

4 files changed

+39
-4
lines changed

.readthedocs.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
version: 2
6+
7+
# Set the version of Python and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.11"
12+
13+
mkdocs:
14+
configuration: mkdocs.yml
15+
16+
python:
17+
install:
18+
- requirements: docs/rtdio_requirements.txt
19+
20+
formats:
21+
- epub
22+
- pdf

docs/getting_started/03_writing_tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Within the `post` dictionary object, an account address can be:
175175
The `Account` object is used to specify the properties of an account to be
176176
verified in the post state.
177177

178-
The python representation can be found in [src/ethereum_test_tools/common/types.py](src/ethereum_test_tools/common/types.py).
178+
The python representation can be found in [src/ethereum_test_tools/common/types.py](https://github.com/ethereum/execution-spec-tests/blob/main/src/ethereum_test_tools/common/types.py).
179179

180180
It can verify the following properties of an account:
181181
- `nonce`: the scalar value equal to a) the number of transactions sent by

docs/rtdio_requirements.txt

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
mkdocs>=1.4.2
2+
mkdocs-glightbox>=0.3.1
3+
watchdog>=2.0
4+
pyyaml>=5.1
5+
markdown<3.4,>=3.2.1
6+
click>=7.0
7+
jinja2>=2.11.1
8+
ghp-import>=1.0
9+
pyyaml-env-tag>=0.1
10+
packaging>=20.5
11+
mergedeep>=1.3.4
12+
python-dateutil>=2.8.1
13+
MarkupSafe>=2.0
14+
six>=1.5
15+
beautifulsoup4>=4.11.1
16+
soupsieve>1.2

mkdocs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
site_name: Ethereum Execution Spec Tests
22
site_url: https://execution-spec-tests.readthedocs.io/
3-
4-
project: 'Ethereum Execution Spec Tests'
53
copyright: 'Copyright: 2023, Ethereum Community'
6-
author: 'Ethereum Community'
74

85
nav:
96
- Home: 'index.md'

0 commit comments

Comments
 (0)