Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a development page to docs #28

Merged
merged 3 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/development.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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
Loading