Skip to content

Commit

Permalink
add install and test to contrib
Browse files Browse the repository at this point in the history
  • Loading branch information
lionel42 committed Dec 4, 2024
1 parent 7158f45 commit 7b026a1
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/source/contrib/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <black.readthedocs.io>`_ 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
-------------------------

Expand Down

0 comments on commit 7b026a1

Please sign in to comment.