Skip to content

Commit b94bc77

Browse files
committed
Document interactive development of mavproxy
* Use a venv and develop mode from setup.py Signed-off-by: Ryan Friedman <[email protected]>
1 parent d2eb328 commit b94bc77

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

mavproxy/source/docs/development/mavdevenvlinux.rst

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,43 @@ The pip-installed MAVProxy will need to uninstalled (if already installed) to pr
1313

1414
.. code:: bash
1515
16-
pip uninstall MAVProxy
16+
python3 -m pip uninstall MAVProxy
1717
1818
Use git to download the MAVProxy source:
1919

2020
.. code:: bash
2121
2222
git clone https://github.com/ArduPilot/MAVProxy.git
2323
24-
After making the desired changes, MAVProxy is required to be installed
25-
(any change to the modules won't work otherwise). This needs to happen after any
26-
changes to the source code. This can be done by:
2724
28-
.. code:: bash
2925
30-
python setup.py build install --user
26+
.. tabs::
27+
28+
.. group-tab:: User Python Environment
29+
30+
After making the desired changes, MAVProxy is required to be installed
31+
(any change to the modules won't work otherwise). This needs to happen after any
32+
changes to the source code. This can be done by:
33+
34+
.. code-block:: bash
35+
36+
python3 setup.py build install --user
37+
38+
39+
.. group-tab:: Virtual Python Environment
40+
41+
Using a virtual environment allows quicker editing.
42+
If you make code changes, just re-run MAVProxy.
43+
44+
.. code-block:: bash
45+
46+
python3 -m venv .venv
47+
source .venv/bin/activate
48+
python3 setup.py develop
3149
3250
MAVProxy can then be run as per normal.
51+
52+
.. code:: bash
53+
54+
which mavproxy.py
55+
mavproxy.py --help

0 commit comments

Comments
 (0)