Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
@s-esposito
s-esposito committed Jan 22, 2025
2 parents 1cb3cd4 + 187b956 commit 3cd8e03
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Installation

How to install the library depends on your use case.

If you want to install the package for *regular usage* without needing further modifications, install the module from source using `pip install .`.
If you want to install the package for *regular usage* without needing further modifications, install the module from source using ``pip install .``.

To perform an *editable installation* (also known as a development mode installation), install the module from source using `pip install -e .`.
To perform an *editable installation* (also known as a development mode installation), install the module from source using ``pip install -e .``.
Changes made to the code in the local directory will take effect immediately when you import the package in Python.

To run tests, install the module with the `tests` extra (e.g. `pip install ".[tests]"`).
To compile the documentation, install the module with the `docs` extra (e.g. `pip install ".[docs]"`).
To run tests, install the module with the ``tests`` extra (e.g. ``pip install ".[tests]"``).
To compile the documentation, install the module with the ``docs`` extra (e.g. ``pip install ".[docs]"``).

The library is tested with Python 3.10; other versions may work, but are not officially supported.
The library is tested with ``Python 3.10``; other versions (``>=3.8``) may work, but are not officially supported.

0 comments on commit 3cd8e03

Please sign in to comment.