From 7b026a184e4f14e6dec6e8469b708b69bf9b8f6c Mon Sep 17 00:00:00 2001 From: coli Date: Wed, 4 Dec 2024 12:03:39 +0100 Subject: [PATCH] add install and test to contrib --- docs/source/contrib/contribute.rst | 44 ++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/docs/source/contrib/contribute.rst b/docs/source/contrib/contribute.rst index 7ead1c7..506a81d 100644 --- a/docs/source/contrib/contribute.rst +++ b/docs/source/contrib/contribute.rst @@ -23,6 +23,50 @@ You can follow the tutorials below to understand how emiproc works and how to expand it. +Installation and testing +------------------------ + +To install emiproc for developpement, we recomment that you run + +.. code-block:: bash + + pip install -e .[dev] + + +You can then run the tests with the command, which you should run +in the main directory of the repository (where the pyproject.toml file is located): + +.. code-block:: bash + + pytest + + +Also, emiproc uses `black `_ for code formatting. You can run it with the command: + +.. code-block:: bash + + black . + + + + +For bulding the documentation, you can run: + +.. code-block:: bash + + cd docs + make html + + +or on Windows: + +.. code-block:: bash + + cd docs + .\make.bat html + + + Tutorials for developpers -------------------------