diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/contribute.rst | 19 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
3 files changed, 21 insertions, 1 deletions
@@ -1,7 +1,7 @@ tests [](https://travis-ci.org/ethereum/tests) ===== -Common tests for all clients to test against. See the documentation http://www.ethdocs.org/en/latest/contracts-and-transactions/ethereum-tests/index.html +Common tests for all clients to test against. See the documentation http://ethereum-tests.readthedocs.io/ Do not change test files in folders: * StateTests diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 000000000..efd984a8f --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,19 @@ +.. _contribute: + +================== +Contribute to Docs +================== + +This documentation has been build using the Python `Sphinx <http://www.sphinx-doc.org/>`_ +documentation tool. + +Since the `Ethereum tests <https://github.com/ethereum/tests>`_ repository is very +large to clone locally, a convenient way to contribute to the documentation is to +make a fork of the test repo, add the changes online with the GitHub markdown editor +and then open a PR. + +If you want to clone to your desk you might want to make use of ``git clone --depth 1`` +for faster download. + +You can build the documentation by running ``make html`` from the ``docs`` directory +in the tests repository. diff --git a/docs/index.rst b/docs/index.rst index 987995c1d..02977a2a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ Ethereum Tests difficulty_tests/index.rst transaction_tests/index.rst vm_tests/index.rst + contribute.rst Indices and tables |