Skip to content

[doc] Use sphinx-design in order to fix doc generation #586

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.

Sign up for GitHub

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

Merged
fredroy merged 1 commit into from
Feb 26, 2026
+22 −22
Merged

[doc] Use sphinx-design in order to fix doc generation #586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/sphinx/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_search.extension',
'sphinx_tabs.tabs',
'sphinx_design.tabs',
]

import sys
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/source/content/Compilation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Prerequisites
The compilation of SofaPython3 requires the installation of some dependencies. The following table lists all of those
prerequisites.

.. tabs::
.. tab-set::

.. tab:: Ubuntu
.. tab-item:: Ubuntu

.. list-table::
:widths: 15 10 30 45
Expand All @@ -45,7 +45,7 @@ prerequisites.
-


.. tab:: MacOS
.. tab-item:: MacOS

.. list-table::
:widths: 15 10 30 45
Expand All @@ -70,7 +70,7 @@ prerequisites.
-


.. tab:: Windows
.. tab-item:: Windows

.. list-table::
:widths: 15 10 30 45
Expand Down
16 changes: 8 additions & 8 deletions docs/sphinx/source/content/Installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Get python installed

First, make sure you have the same version of python installed on your computer as the one that is used in the binary version.

.. tabs::
.. tab-set::

.. tab:: Ubuntu
.. tab-item:: Ubuntu

Run in a terminal:

Expand All @@ -40,7 +40,7 @@ First, make sure you have the same version of python installed on your computer
sudo apt install libopengl0


.. tab:: MacOS
.. tab-item:: MacOS

Run in a terminal:

Expand All @@ -63,7 +63,7 @@ First, make sure you have the same version of python installed on your computer
pip3 install numpy


.. tab:: Windows
.. tab-item:: Windows

Download and install `Python 3.12 64bit <https://www.python.org/ftp/python/3.12.1/python-3.12.1-amd64.exe>`_

Expand Down Expand Up @@ -97,9 +97,9 @@ using python3
Before running your simulations, you must make sure to define the following environment variables:


.. tabs::
.. tab-set::

.. tab:: Ubuntu
.. tab-item:: Ubuntu

Run in a terminal:

Expand All @@ -108,7 +108,7 @@ Before running your simulations, you must make sure to define the following envi
export SOFA_ROOT=/path/to/SOFA_install
export PYTHONPATH=/path/to/SofaPython3/lib/python3/site-packages:$PYTHONPATH

.. tab:: MacOS
.. tab-item:: MacOS

Run in a terminal:

Expand All @@ -119,7 +119,7 @@ Before running your simulations, you must make sure to define the following envi
export PATH="/usr/local/opt/python@3.12/bin/:$PATH"


.. tab:: Windows
.. tab-item:: Windows

* Create a system variable **SOFA_ROOT** and set it to ``<SOFA-install-directory>``
* Create a system variable **PYTHON_ROOT** and set it to ``<Python3-install-directory>``
Expand Down
16 changes: 8 additions & 8 deletions docs/sphinx/source/content/UsingThePlugin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Prerequisites

If you downloaded and installed SOFA and its headers from the `SOFA website <https://www.sofa-framework.org/download/>`_, make sure to have python3.10 installed on your computer.

.. tabs::
.. tab-set::

.. tab:: Ubuntu
.. tab-item:: Ubuntu

Run in a terminal:

Expand All @@ -31,7 +31,7 @@ If you downloaded and installed SOFA and its headers from the `SOFA website <htt
sudo apt install libopengl0


.. tab:: MacOS
.. tab-item:: MacOS

Run in a terminal:

Expand All @@ -54,7 +54,7 @@ If you downloaded and installed SOFA and its headers from the `SOFA website <htt
pip3 install numpy


.. tab:: Windows
.. tab-item:: Windows

Download and install `Python 3.10 64bit <https://www.python.org/ftp/python/3.10.10/python-3.10.10-amd64.exe>`_

Expand Down Expand Up @@ -98,9 +98,9 @@ Within a python3 interpreter
Before running your simulations, you must make sure to define the following environment variables:


.. tabs::
.. tab-set::

.. tab:: Ubuntu
.. tab-item:: Ubuntu

Run in a terminal:

Expand All @@ -109,7 +109,7 @@ Before running your simulations, you must make sure to define the following envi
export SOFA_ROOT=/path/to/SOFA_install
export PYTHONPATH=/path/to/SofaPython3/lib/python3/site-packages:$PYTHONPATH

.. tab:: MacOS
.. tab-item:: MacOS

Run in a terminal:

Expand All @@ -120,7 +120,7 @@ Before running your simulations, you must make sure to define the following envi
export PATH="/usr/local/opt/python@3.10/bin/:$PATH"


.. tab:: Windows
.. tab-item:: Windows

* Create a system variable **SOFA_ROOT** and set it to ``<SOFA-install-directory>``
* Create a system variable **PYTHON_ROOT** and set it to ``<Python3-install-directory>``
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ sphinxcontrib-contentui
readthedocs-sphinx-search
sphinx-autodoc-typehints
sphinx-rtd-theme
sphinx-tabs
sphinx-design
sphinx-autosummary-autocollect
Loading