Skip to content

Commit

Permalink
mavproxy: Document interactive development of mavproxy
Browse files Browse the repository at this point in the history
* Use a venv and develop mode from setup.py

Signed-off-by: Ryan Friedman <[email protected]>
  • Loading branch information
Ryanf55 committed Nov 6, 2024
1 parent 924a92f commit 589f38a
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions mavproxy/source/docs/development/mavdevenvlinux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,46 @@ The pip-installed MAVProxy will need to uninstalled (if already installed) to pr

.. code:: bash
pip uninstall MAVProxy
python3 -m pip uninstall MAVProxy
Use git to download the MAVProxy source:

.. code:: bash
git clone https://github.com/ArduPilot/MAVProxy.git
After making the desired changes, MAVProxy is required to be installed
(any change to the modules won't work otherwise). This needs to happen after any
changes to the source code. This can be done by:
.. code:: bash
python3 -m pip install .
.. tabs::

.. group-tab:: User Python Environment

After making the desired changes, MAVProxy is required to be installed
(any change to the modules won't work otherwise). This needs to happen after any
changes to the source code. This can be done by:

.. code-block:: bash
python -m pip install .
.. group-tab:: Virtual Python Environment

Using a virtual environment allows quicker editing.
If you make code changes, just re-run MAVProxy.
We give access to system site packages because
compiling wx in a virtual environment is extremely difficult.
Instead, rely on the host OS to supply that.

.. code-block:: bash
python3 -m venv .venv --system-site-packages
source .venv/bin/activate
python -m pip install --editable .
MAVProxy can then be run as per normal.

.. code:: bash
which mavproxy.py
mavproxy.py --help

0 comments on commit 589f38a

Please sign in to comment.