Skip to content

Commit

Permalink
Recover development in docs and add link
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescMartiEscofetQC committed Jul 4, 2024
1 parent 5545f37 commit dadb2fc
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 31 deletions.
32 changes: 1 addition & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,34 +24,4 @@ $ conda install metalearners -c conda-forge

## Development

The `metalearners` repository can be cloned as follows

```bash
$ 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:

```bash
$ pixi run pre-commit-install
$ pixi run pre-commit-run
```

You can run the tests as follows:

```bash
$ pixi run postinstall
$ pixi run pytest tests
```

You can build the documentation locally by running

```bash
$ 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`.
Development instructions can be found [here](https://metalearners.readthedocs.io/en/latest/development.html).
29 changes: 29 additions & 0 deletions docs/development.rst
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``.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit dadb2fc

Please sign in to comment.