From 4c97f299964bd59ac06e5435a20db06d9d655567 Mon Sep 17 00:00:00 2001 From: hugtalbot Date: Thu, 24 Jul 2025 17:40:23 +0200 Subject: [PATCH 1/2] [doc] Fix links in FirstSteps --- docs/sphinx/source/content/FirstSteps.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/content/FirstSteps.rst b/docs/sphinx/source/content/FirstSteps.rst index 5697879eb..dc4bcbf16 100644 --- a/docs/sphinx/source/content/FirstSteps.rst +++ b/docs/sphinx/source/content/FirstSteps.rst @@ -12,7 +12,7 @@ With runSofa * open runSofa without any argument once and then add libSofaPython3 in the plugin manager * or add -l SofaPython3 in this command line. -For more information, please refer to the documentation: `What is a plugin > Plugin loading`_ +For more information, please refer to the documentation: `Plugin loading `_. Once the SofaPython3 plugin is loaded, you can load a simulation from a python script directly in runSofa. Assuming you want to run a script named "example.py", you can run the following command: @@ -32,7 +32,7 @@ With the python3 interpreter SOFA simulation can also be executed from a python environment (including jupyter notebook). To do so, the Python environment must be filled in for SOFA python modules. Located in *site-packages/* repositories, the path to these libraries should be added to the ``PYTHONPATH``. -The section "`Setup your python3 environment `_" section details how to configure it. +The Installation section details the `requirements to execute a simulation withing a python3 interpreter `_" section details how to configure it. Once your python environment is properly configured, you will be able to import SOFA python modules (e.g. ``import Sofa``). By running your simulation from a python interpreter, you will be responsible for: From bc473267c6508aae42fed488a66bb66367e3e019 Mon Sep 17 00:00:00 2001 From: hugtalbot Date: Thu, 24 Jul 2025 17:44:13 +0200 Subject: [PATCH 2/2] help readibility --- docs/sphinx/source/content/Installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/source/content/Installation.rst b/docs/sphinx/source/content/Installation.rst index 9ce3f9ae1..7c9953754 100644 --- a/docs/sphinx/source/content/Installation.rst +++ b/docs/sphinx/source/content/Installation.rst @@ -130,7 +130,7 @@ Before running your simulations, you must make sure to define the following envi After that, all you need to do is open a Console (cmd.exe) and run: ``runSofa -lSofaPython3`` -It must be noted that depending on the plugins you use, you might have to add the *site-packages/* paths associated to these plugins to your ``PYTHONPATH``. +⚠️ It must be noted that depending on the plugins you use, you might have to add the *site-packages/* paths associated to these plugins to your ``PYTHONPATH``. These are usually located in */path_to_plugin/lib/python3/site-packages*. To discover, how to use SOFA in any python3 interpreter, please refer to the associated `FirstSteps section `_ @@ -139,6 +139,6 @@ To discover, how to use SOFA in any python3 interpreter, please refer to the ass Get support *********** -To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum `_ and post there any question related to SofaPython3. +🙋 To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum `_ and post there any question related to SofaPython3. -To quickly level up on SOFA, never hesitate to request `SOFA training sessions `_. +👨‍🏫 To quickly level up on SOFA, never hesitate to request `SOFA training sessions `_.