Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document interactive development of mavproxy #6371

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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