aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorholgerd77 <Holger.Drewes@gmail.com>2017-08-29 04:40:02 +0800
committerholgerd77 <Holger.Drewes@gmail.com>2017-08-30 01:23:44 +0800
commitd6017615a28f37f95bff1603534e83f2b66f21b4 (patch)
tree97550aa6496e92c7909a7ba380029217d57536f1 /docs
parent9d5f57bc8664d27283759a2e9ec08e981d5d54fc (diff)
downloaddexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar.gz
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar.bz2
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar.lz
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar.xz
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.tar.zst
dexon-tests-d6017615a28f37f95bff1603534e83f2b66f21b4.zip
Added note on outdated docs, seek for help
Diffstat (limited to 'docs')
-rw-r--r--docs/contribute.rst3
-rw-r--r--docs/index.rst5
2 files changed, 7 insertions, 1 deletions
diff --git a/docs/contribute.rst b/docs/contribute.rst
index efd984a8f..02055b463 100644
--- a/docs/contribute.rst
+++ b/docs/contribute.rst
@@ -9,7 +9,8 @@ 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
+make a fork of the test repo, add the changes online with the GitHub
+`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ 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``
diff --git a/docs/index.rst b/docs/index.rst
index 02977a2a6..cfd45916f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,6 +7,10 @@ Ethereum Tests
| This section describes basic test concepts and templates which are created by cpp-client.
|
+.. note::
+ Larger parts of the test docs are currently outdated (see :ref:`contribute` on how to
+ help).
+
.. toctree::
:maxdepth: 2
:caption: Contents:
@@ -20,6 +24,7 @@ Ethereum Tests
vm_tests/index.rst
contribute.rst
+
Indices and tables
==================