Skip to content

Commit 078d5aa

Browse files
committed
update docs to reflect editable install instructions
1 parent 0e93e71 commit 078d5aa

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/contribute.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ If you have an issue with pyOptSparse, a bug to report, or a feature to request,
88
This lets other users know about the issue.
99
If you are comfortable fixing the issue, please do so and submit a pull request.
1010

11+
Editable Installs
12+
-----------------
13+
Due to the use of ``meson-python`` as the backend, the typical process of using ``pip install -e .`` to generate an editable install cannot be used.
14+
Instead, based on the instructions `here <https://mesonbuild.com/meson-python/how-to-guides/editable-installs.html#editable-installs>`__,
15+
you must first install the `build dependencies` yourself.
16+
This can be done by looking at the ``requires`` field of the ``[build-system]`` section of the ``pyproject.toml`` file.
17+
Then, do the following:
18+
19+
.. prompt:: bash
20+
21+
pip install --no-build-isolation --editable .
22+
23+
To run tests, ensure that the testing dependencies specified in the ``pyproject.toml`` file are also installed.
24+
1125
Coding style
1226
------------
1327
We use `ruff <https://github.com/astral-sh/ruff>`_ and `pre-commit <https://github.com/pre-commit/pre-commit/>`_ for linting and formatting.

0 commit comments

Comments
 (0)