From 190b8584cd5d5fadc2a0ec01e467b8d427c90517 Mon Sep 17 00:00:00 2001
From: kklein <kevin.klein@quantco.com>
Date: Tue, 25 Jun 2024 19:02:48 +0200
Subject: [PATCH 1/3] Draft development page.

---
 docs/development.rst | 37 +++++++++++++++++++++++++++++++++++++
 docs/index.rst       |  1 +
 2 files changed, 38 insertions(+)
 create mode 100644 docs/development.rst

diff --git a/docs/development.rst b/docs/development.rst
new file mode 100644
index 0000000..2ef7774
--- /dev/null
+++ b/docs/development.rst
@@ -0,0 +1,37 @@
+Development
+===========
+
+The ``metalearners`` repository can be cloned as follows
+
+.. code-block:: console
+
+  git clone https://github.com/Quantco/metalearners.git
+
+The dependencies are managed via
+`pixi <https://pixi.sh/latest/>`_. Please make sure to install `pixi` on
+your system. Once pixi is installed, you can install and run the
+pre-commit hooks as follows:
+
+
+.. code-block:: console
+
+  pixi run pre-commit-install
+  pixi run pre-commit-run
+
+
+You can run the tests as follows:
+
+.. code-block:: console
+
+  pixi run postinstall
+  pixi run pytest tests
+
+You can build the documentation locally by running
+
+.. code-block:: console
+
+  pixi run docs
+
+You can then inspect the locally built docs by opening ``docs/_build/index.html``.
+
+You can find all pixi tasks in ``pixi.toml``.
diff --git a/docs/index.rst b/docs/index.rst
index 11e9943..f04a8ee 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -10,6 +10,7 @@ Welcome to metalearners's documentation!
    Glossary <glossary.rst>
    What about parallelism? <parallelism.rst>
    Examples <examples/index.rst>
+   Development <development.rst>
    FAQ <faq.rst>
    API Reference <api/modules>
    Change Log <changelog.rst>

From 4afa496a868da1da852f5d2db863778e3d9a7ea2 Mon Sep 17 00:00:00 2001
From: kklein <kevin.klein@quantco.com>
Date: Tue, 25 Jun 2024 19:17:51 +0200
Subject: [PATCH 2/3] Fix formatting.

---
 docs/development.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/development.rst b/docs/development.rst
index 2ef7774..ac01494 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -8,7 +8,7 @@ The ``metalearners`` repository can be cloned as follows
   git clone https://github.com/Quantco/metalearners.git
 
 The dependencies are managed via
-`pixi <https://pixi.sh/latest/>`_. Please make sure to install `pixi` on
+`pixi <https://pixi.sh/latest/>`_. Please make sure to install ``pixi`` on
 your system. Once pixi is installed, you can install and run the
 pre-commit hooks as follows:
 

From e40b3fc9f9a2e1a5d4f2b948953a560cbf3aef80 Mon Sep 17 00:00:00 2001
From: kklein <kevin.klein@quantco.com>
Date: Wed, 26 Jun 2024 08:37:26 +0200
Subject: [PATCH 3/3] Add missing postinstall.

---
 docs/development.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/development.rst b/docs/development.rst
index ac01494..711520d 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -30,7 +30,8 @@ You can build the documentation locally by running
 
 .. code-block:: console
 
-  pixi run docs
+  pixi run -e docs postinstall
+  pixi run -e docs docs
 
 You can then inspect the locally built docs by opening ``docs/_build/index.html``.