From ddd8b06fad864740c91996d4dce5bdbfafd18b7c Mon Sep 17 00:00:00 2001 From: Yoan Dumas Date: Sun, 21 Jan 2024 13:48:52 +0100 Subject: [PATCH] [DOCs] fix typo and add python virtual env support for pcbnew Signed-off-by: Yoan Dumas --- docs/source/configuration/quick_start.rst | 2 +- docs/source/installation.rst | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/configuration/quick_start.rst b/docs/source/configuration/quick_start.rst index 725d023d..ef502883 100644 --- a/docs/source/configuration/quick_start.rst +++ b/docs/source/configuration/quick_start.rst @@ -4,7 +4,7 @@ Quick start ~~~~~~~~~~~ -If you want to *learn by examples*, or you just want to take a look a +If you want to *learn by examples*, or you just want to take a look at what KiBot can do, you can use the ``--quick-start`` command line option. diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 1a958484..7ee28825 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -144,8 +144,18 @@ Notes about virtualenv ~~~~~~~~~~~~~~~~~~~~~~ If you try to use a Python virtual environment you’ll need to find a way -to make the KiCad module (``pcbnew``) available on it. I don’t know how -to make it. +to make the KiCad module (``pcbnew``) available on it. From the `linked +GitHub issue +`_ +, to make the ``pcbnew`` available on the virtual env, you will need to +run the following command: + +.. code:: shell + + python -m venv --system-site-packages venv + +Then python started in the venv will look at the packages in the system +location, which is where KiCad puts its python code. In addition: note that the virtual env will change the system share data paths. They will no longer point to things like ``/usr/share/`` but to a