diff options
Diffstat (limited to 'docs/contribute.rst')
| -rw-r--r-- | docs/contribute.rst | 19 |
1 files changed, 19 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. |