-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Recover development in docs and add link
- Loading branch information
1 parent
5545f37
commit dadb2fc
Showing
3 changed files
with
31 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
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``. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters