Skip to content

Commit

Permalink
Recover spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescMartiEscofetQC committed Jul 4, 2024
1 parent dadb2fc commit 306202a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,35 @@ 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 -e docs postinstall
pixi run -e docs docs
You can then inspect the locally built docs by opening ``docs/_build/index.html``.

You can find all pixi tasks in ``pixi.toml``.

0 comments on commit 306202a

Please sign in to comment.