Skip to content

Commit e42fc90

Browse files
authored
[doc] Fix links in FirstSteps (#526)
* [doc] Fix links in FirstSteps * help readibility
1 parent f0535cf commit e42fc90

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/sphinx/source/content/FirstSteps.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ With runSofa
1212
* open runSofa without any argument once and then add libSofaPython3 in the plugin manager
1313
* or add -l SofaPython3 in this command line.
1414

15-
For more information, please refer to the documentation: `What is a plugin > Plugin loading<https://sofa-framework.github.io/doc/plugins/what-is-a-plugin/#plugin_loading>`_
15+
For more information, please refer to the documentation: `Plugin loading <https://sofa-framework.github.io/doc/plugins/what-is-a-plugin/#plugin_loading>`_.
1616

1717
Once the SofaPython3 plugin is loaded, you can load a simulation from a python script directly in runSofa.
1818
Assuming you want to run a script named "example.py", you can run the following command:
@@ -32,7 +32,7 @@ With the python3 interpreter
3232
SOFA simulation can also be executed from a python environment (including jupyter notebook).
3333
To do so, the Python environment must be filled in for SOFA python modules.
3434
Located in *site-packages/* repositories, the path to these libraries should be added to the ``PYTHONPATH``.
35-
The section "`Setup your python3 environment <https://sofapython3.readthedocs.io/en/latest/content/Installation.html#using-python3>`_" section details how to configure it.
35+
The Installation section details the `requirements to execute a simulation withing a python3 interpreter <https://sofapython3.readthedocs.io/en/latest/content/Installation.html#using-python3>`_" section details how to configure it.
3636

3737
Once your python environment is properly configured, you will be able to import SOFA python modules (e.g. ``import Sofa``).
3838
By running your simulation from a python interpreter, you will be responsible for:

docs/sphinx/source/content/Installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ Before running your simulations, you must make sure to define the following envi
130130
After that, all you need to do is open a Console (cmd.exe) and run: ``runSofa -lSofaPython3``
131131

132132

133-
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``.
133+
⚠️ 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``.
134134
These are usually located in */path_to_plugin/lib/python3/site-packages*.
135135

136136
To discover, how to use SOFA in any python3 interpreter, please refer to the associated `FirstSteps section <https://sofapython3.readthedocs.io/en/latest/content/FirstSteps.html#with-the-python3-interpreter>`_
@@ -139,6 +139,6 @@ To discover, how to use SOFA in any python3 interpreter, please refer to the ass
139139
Get support
140140
***********
141141

142-
To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum <https://github.com/sofa-framework/sofapython3/discussions>`_ and post there any question related to SofaPython3.
142+
🙋 To freely get technical assistance from the community, please do not hesitate to join the `SofaPython3 GitHub forum <https://github.com/sofa-framework/sofapython3/discussions>`_ and post there any question related to SofaPython3.
143143

144-
To quickly level up on SOFA, never hesitate to request `SOFA training sessions <https://www.sofa-framework.org/sofa-events/sofa-training-sessions/>`_.
144+
👨‍🏫 To quickly level up on SOFA, never hesitate to request `SOFA training sessions <https://www.sofa-framework.org/sofa-events/sofa-training-sessions/>`_.

0 commit comments

Comments
 (0)