Skip to content

Commit

Permalink
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 <25047695+Ryanf55@users.noreply.github.com>
  • Loading branch information
Ryanf55 committed Nov 6, 2024
1 parent d2eb328 commit 70afbea
Showing 1 changed file with 30 additions and 5 deletions.
35 changes: 30 additions & 5 deletions mavproxy/source/docs/development/mavdevenvlinux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,45 @@ 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:
.. 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
python3 setup.py build install --user
.. group-tab:: Virtual Python Environment

Using a virtual environment allows quicker editing.

.. code-block:: bash
python3 -m venv .venv
source .venv/bin/activate
python3 setup.py develop
.. code:: bash
python setup.py build install --user
python3 setup.py build install --user
MAVProxy can then be run as per normal.

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

0 comments on commit 70afbea

Please sign in to comment.