From 6aff2ba8a804b3c262a4aba9f2376a6e3ba4c36e Mon Sep 17 00:00:00 2001
From: Eivind Jahren <ejah@equinor.com>
Date: Sat, 25 Jun 2022 21:57:23 +0200
Subject: [PATCH] Add developer guide and api doc

---
 README.md                       |  2 +-
 docs/source/api_doc.rst         | 12 ++++++++++++
 docs/source/developer_guide.rst | 26 ++++++++++++++++++++++++++
 docs/source/example_usage.rst   |  2 +-
 4 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 docs/source/api_doc.rst
 create mode 100644 docs/source/developer_guide.rst

diff --git a/README.md b/README.md
index 2b3e940..d3a9424 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@ Getting started
 ===============
 
 Ecl output files consist of a sequence of named arrays. ecl-data-io does not
-interpret the names, but simply give you a touple of the name and a numpy array
+interpret the names, but simply give you a tuple of the name and a numpy array
 with the read function:
 
 ```
diff --git a/docs/source/api_doc.rst b/docs/source/api_doc.rst
new file mode 100644
index 0000000..76b949e
--- /dev/null
+++ b/docs/source/api_doc.rst
@@ -0,0 +1,12 @@
+API-Doc
+=======
+
+.. autofunction:: ecl_data_io.lazy_read
+
+.. autofunction:: ecl_data_io.read
+
+.. autofunction:: ecl_data_io.write
+
+.. autoclass:: ecl_data_io.Format
+
+.. autoclass:: ecl_data_io.MESS
diff --git a/docs/source/developer_guide.rst b/docs/source/developer_guide.rst
new file mode 100644
index 0000000..016d4d6
--- /dev/null
+++ b/docs/source/developer_guide.rst
@@ -0,0 +1,26 @@
+Building from source and running the tests
+==========================================
+
+ecl-data-io is set up to use tox which can simplify development,
+but all that is necessary in order to get started is git, pip and python:
+
+First, install ecl-data-io in editable mode:
+
+.. code-block:: console
+
+git clone git@github.com:equinor/ecl-data-io.git
+cd ecl-data-io
+pip install -e .
+
+Second, install the dev-requirements.txt, which contains the packages ecl-data-io
+require in order to run tests:
+
+.. code-block:: console
+
+pip install -r dev-requirements.txt
+
+At last, you can use pytest to run the tests
+
+.. code-block:: console
+
+pytest tests
diff --git a/docs/source/example_usage.rst b/docs/source/example_usage.rst
index 4203297..81a2cb4 100644
--- a/docs/source/example_usage.rst
+++ b/docs/source/example_usage.rst
@@ -9,7 +9,7 @@ and :meth:`ecl_data_io.write` functions:
 read
 ----
 
-The read function will open a given file and give you a list of touples
+The read function will open a given file and give you a list of tuples
 of the keywords and arrays.
 
 >>> import ecl_data_io as eclio