Merge pull request ethereum#166 from danceratopz/docs/update-github-p…

…ages-link-in-readme

docs: update link to github pages

README.md

@@ -60,7 +60,7 @@ The following requires a Python 3.10 installation.
 
 ### Quick Start
 
-This guide installs stable versions of the required external `evm` and `solc` executables and will only enable generation of test fixtures for features deployed to mainnet. In order to generate fixtures for features under active development, you can follow the steps below and then follow the [additional steps in the online doc](https://danceratopz.github.io/execution-spec-tests/getting_started/executing_tests_dev_fork/).
+This guide installs stable versions of the required external `evm` and `solc` executables and will only enable generation of test fixtures for features deployed to mainnet. In order to generate fixtures for features under active development, you can follow the steps below and then follow the [additional steps in the online doc](https://ethereum.github.io/execution-spec-tests/getting_started/executing_tests_dev_fork/).
 
 1. Ensure go-ethereum's `evm` tool and `solc` are in your path. Either build the required versions, or alternatively:
 
@@ -75,7 +75,7 @@ This guide installs stable versions of the required external `evm` and `solc` ex
     - [geth installation doc](https://geth.ethereum.org/docs/getting-started/installing-geth#ubuntu-via-ppas).
     - [solc installation doc](https://docs.soliditylang.org/en/latest/installing-solidity.html#linux-packages).
 
-    Help for other platforms is available in the [online doc](https://danceratopz.github.io/execution-spec-tests/getting_started/quick_start/).
+    Help for other platforms is available in the [online doc](https://ethereum.github.io/execution-spec-tests/getting_started/quick_start/).
 
 2. Clone the [execution-spec-tests](https://github.com/ethereum/execution-spec-tests) repo and install its and dependencies (it's recommended to use a virtual environment for the installation):
 
@@ -116,20 +116,20 @@ This guide installs stable versions of the required external `evm` and `solc` ex
 
 ## Coverage
 
-The available test cases can be browsed in the [Test Case Reference doc](https://danceratopz.github.io/execution-spec-tests/tests/).
+The available test cases can be browsed in the [Test Case Reference doc](https://ethereum.github.io/execution-spec-tests/tests/).
 
 ## Usage
 
-See the [online documentation](https://danceratopz.github.io/execution-spec-tests/) for further help with working with this codebase:
+See the [online documentation](https://ethereum.github.io/execution-spec-tests/) for further help with working with this codebase:
 
-1. Learn [useful command-line flags](https://danceratopz.github.io/execution-spec-tests/getting_started/executing_tests_command_line/).
-2. [Execute tests for features under development](https://danceratopz.github.io/execution-spec-tests/getting_started/executing_tests_dev_fork/) via the `--from=FORK1` and `--until=FORK2` flags.
-3. _Optional:_ [Configure VS Code](https://danceratopz.github.io/execution-spec-tests/getting_started/setup_vs_code/) to auto-format Python code and [execute tests within VS Code](https://danceratopz.github.io/execution-spec-tests/getting_started/executing_tests_vs_code/#executing-and-debugging-test-cases).
-4. Implement a new test case, see [Writing Tests](https://danceratopz.github.io/execution-spec-tests/writing_tests/).
+1. Learn [useful command-line flags](https://ethereum.github.io/execution-spec-tests/getting_started/executing_tests_command_line/).
+2. [Execute tests for features under development](https://ethereum.github.io/execution-spec-tests/getting_started/executing_tests_dev_fork/) via the `--from=FORK1` and `--until=FORK2` flags.
+3. _Optional:_ [Configure VS Code](https://ethereum.github.io/execution-spec-tests/getting_started/setup_vs_code/) to auto-format Python code and [execute tests within VS Code](https://ethereum.github.io/execution-spec-tests/getting_started/executing_tests_vs_code/#executing-and-debugging-test-cases).
+4. Implement a new test case, see [Writing Tests](https://ethereum.github.io/execution-spec-tests/writing_tests/).
 
 ## Contributing
 
-Contributions and feedback are welcome. Please see the [online documentation](https://danceratopz.github.io/execution-spec-tests/writing_tests/) for this repository's coding standards and help on implementing new tests.
+Contributions and feedback are welcome. Please see the [online documentation](https://ethereum.github.io/execution-spec-tests/writing_tests/) for this repository's coding standards and help on implementing new tests.
 
 ## License
 

docs/dev/docs.md

@@ -1,49 +1,37 @@
 # Documentation
 
-The `execution-spec-tests` documentation is generated via [`mkdocs`](https://www.mkdocs.org/) and hosted remotely on [readthedocs.io](https://execution-spec-tests.readthedocs.io/en/latest/).
+The `execution-spec-tests` documentation is generated via [`mkdocs`](https://www.mkdocs.org/) and hosted remotely on Github Pages at [ethereum.github.io/execution-spec-tests](https://ethereum.github.io/execution-spec-tests/).
 
 ## Prerequisites
+
 ```console
 pip install -e .[docs]
 ```
 
 ## Build the Documentation
+
 One time build:
 ```console
 mkdocs build
 ```
 
 ### Local Deployment and Test
 This runs continually and re-generates the documentation upon changes in the `./docs/` sub-director and deploys the site locally ([127.0.0.1:8000](http://127.0.0.1:8000/), by default):
+
 ```console
 mkdocs serve
 ```
 Note: The `gen-files` plugin currently breaks the `serve` command by continually re-generating the documentation. Disable this config in mkdocs.yml to avoid this behaviour.
 
-
 ### Test Remote Deployment
-This can be used to generate and deploy a local version of the documentation remotely on Github pages in order to share a preview with other developers. Note, as the documentation is generated locally, even changes that have not been pushed will be deployed:
-```console
-mkdocs gh-deploy
-```
-It will be deployed to the Github pages of the repo's username (branch is ignored), e.g., [https://danceratopz.github.io/execution-spec-tests](https://danceratopz.github.io/execution-spec-tests).
-
 
-### Production Deployment
-
-Ensure that `docs/rtdio_requirements.txt` is up-to-date as following:
+This can be used to generate and deploy a local version of the documentation remotely on Github pages in order to share a preview with other developers. Note, as the documentation is generated locally, even changes that have not been pushed will be deployed:
 
 ```console
-rm -rf venv-docs
-python -m venv ./venv-docs
-source ./venv-docs/bin/activate.sh
-pip install -e .[docs]
-mkdocs serve
-# -> check console output / build
-pip freeze > ./docs/rtdio_requirements.txt
+mkdocs gh-deploy
 ```
 
-Read the docs should pick up a push to the `main` branch and deploy an up-to-date version of the documentation. Active maintainers who wish to manage the documentation on [readthedocs.org](https://readthedocs.org/projects/execution-spec-tests/) require a readthedocs account and be given permission (please ask one of the active maintainers).
+It will be deployed to the Github pages of the repo's username (branch is ignored), e.g., [https://danceratopz.github.io/execution-spec-tests](https://danceratopz.github.io/execution-spec-tests).
 
 ## Implementation
 

docs/index.md

@@ -4,7 +4,7 @@
  ![Execution Spec Tests Logo](img/execution_spec_tests.png){ width="400" align=right}
 </figure>
 
-[ethereum/execution-spec-tests](https://github.com/ethereum/execution-spec-tests) is both a collection of test cases and a framework to generate tests for Ethereum execution clients implemented in Python.
+[ethereum/execution-spec-tests](https://github.com/ethereum/execution-spec-tests) is both a collection of test cases and a framework in Python to generate tests for Ethereum execution clients implemented.
 
 The framework collects and executes the test cases in order to generate _test fixtures_ (JSON) which can be consumed by any execution client to verify their implementation of [ethereum/execution-specs](https://github.com/ethereum/execution-specs). Currently, the fixtures, which define state transition and block tests, are generated by the framework using the `t8n` and `b11r` commands from the [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum) `evm` command-line tool. Integration of other `t8n` tools is planned.
 

docs/writing_tests/writing_a_new_test.md

@@ -9,7 +9,7 @@ Every test case is defined as a python function that defines a single `StateTest
 | Be [decorated with validity markers](#specifying-which-forks-tests-are-valid-for) | If the test case is not valid for all forks |
 | Use one of `state_test` or `blockchain_test` [in its function arguments](#the-state_test-and-blockchain_test-test-function-arguments) | Always |
 | Call the `state_test` or `blockchain_test` in its test body                                                                           | Always |
-| Add a [reference version of the EIP spec](./reference_specification.md) under test | Test case located under `./tests/eips/`    |
+| Add a [reference version of the EIP spec](./reference_specification.md) under test | Test path contains `eip`  |
 
 ### Specifying which Forks Tests are Valid For
 

mkdocs.yml

@@ -1,7 +1,6 @@
 site_name: Ethereum Execution Spec Tests
 site_description: A collection of test cases implemented in Python for Ethereum execution clients
-# site_url: https://execution-spec-tests.readthedocs.io/
-site_url: https://danceratopz.github.io/execution-spec-tests/
+site_url: https://ethereum.github.io/execution-spec-tests/
 repo_url: https://github.com/ethereum/execution-spec-tests
 repo_name: execution-spec-tests
 edit_uri: edit/main/docs/

src/entry_points/tf.py

@@ -10,7 +10,7 @@ def main():  # noqa: D103
     print(
         "The `tf` command-line tool has been superseded by `fill`, please "
         "see the docs for help running `fill`:\n"
-        "https://danceratopz.github.io/execution-spec-tests/getting_started/executing_tests_command_line/"  # noqa: E501
+        "https://ethereum.github.io/execution-spec-tests/getting_started/executing_tests_command_line/"  # noqa: E501
     )
     sys.exit(1)