aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorholgerd77 <Holger.Drewes@gmail.com>2017-08-29 02:31:28 +0800
committerholgerd77 <Holger.Drewes@gmail.com>2017-08-30 01:23:44 +0800
commit9d5f57bc8664d27283759a2e9ec08e981d5d54fc (patch)
tree3b016f84587f4dff29967e6168d2bc5f75428eaf /docs
parent8477fc273c31f839119847731f029f10a8648bd2 (diff)
downloaddexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar.gz
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar.bz2
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar.lz
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar.xz
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.tar.zst
dexon-tests-9d5f57bc8664d27283759a2e9ec08e981d5d54fc.zip
Updated test doc URL in README, added some contribution notes
Diffstat (limited to 'docs')
-rw-r--r--docs/contribute.rst19
-rw-r--r--docs/index.rst1
2 files changed, 20 insertions, 0 deletions
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