Skip to content

Commit 833bd69

Browse files
hugtalbothugtalbot
andauthored
[doc] Use sphinx-design in order to fix doc generation (#586)
Co-authored-by: hugtalbot <hugo.talbot@inria.fr>
1 parent d982bc8 commit 833bd69

5 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/sphinx/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
'sphinx.ext.viewcode',
3939
'sphinx.ext.napoleon',
4040
'sphinx_search.extension',
41-
'sphinx_tabs.tabs',
41+
'sphinx_design.tabs',
4242
]
4343

4444
import sys

docs/sphinx/source/content/Compilation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Prerequisites
1818
The compilation of SofaPython3 requires the installation of some dependencies. The following table lists all of those
1919
prerequisites.
2020

21-
.. tabs::
21+
.. tab-set::
2222

23-
.. tab:: Ubuntu
23+
.. tab-item:: Ubuntu
2424

2525
.. list-table::
2626
:widths: 15 10 30 45
@@ -45,7 +45,7 @@ prerequisites.
4545
-
4646

4747

48-
.. tab:: MacOS
48+
.. tab-item:: MacOS
4949

5050
.. list-table::
5151
:widths: 15 10 30 45
@@ -70,7 +70,7 @@ prerequisites.
7070
-
7171

7272

73-
.. tab:: Windows
73+
.. tab-item:: Windows
7474

7575
.. list-table::
7676
:widths: 15 10 30 45

docs/sphinx/source/content/Installation.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Get python installed
2121

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

24-
.. tabs::
24+
.. tab-set::
2525

26-
.. tab:: Ubuntu
26+
.. tab-item:: Ubuntu
2727

2828
Run in a terminal:
2929

@@ -40,7 +40,7 @@ First, make sure you have the same version of python installed on your computer
4040
sudo apt install libopengl0
4141
4242
43-
.. tab:: MacOS
43+
.. tab-item:: MacOS
4444

4545
Run in a terminal:
4646

@@ -63,7 +63,7 @@ First, make sure you have the same version of python installed on your computer
6363
pip3 install numpy
6464
6565
66-
.. tab:: Windows
66+
.. tab-item:: Windows
6767

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

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

9999

100-
.. tabs::
100+
.. tab-set::
101101

102-
.. tab:: Ubuntu
102+
.. tab-item:: Ubuntu
103103

104104
Run in a terminal:
105105

@@ -108,7 +108,7 @@ Before running your simulations, you must make sure to define the following envi
108108
export SOFA_ROOT=/path/to/SOFA_install
109109
export PYTHONPATH=/path/to/SofaPython3/lib/python3/site-packages:$PYTHONPATH
110110
111-
.. tab:: MacOS
111+
.. tab-item:: MacOS
112112

113113
Run in a terminal:
114114

@@ -119,7 +119,7 @@ Before running your simulations, you must make sure to define the following envi
119119
export PATH="/usr/local/opt/python@3.12/bin/:$PATH"
120120
121121
122-
.. tab:: Windows
122+
.. tab-item:: Windows
123123

124124
* Create a system variable **SOFA_ROOT** and set it to ``<SOFA-install-directory>``
125125
* Create a system variable **PYTHON_ROOT** and set it to ``<Python3-install-directory>``

docs/sphinx/source/content/UsingThePlugin.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Prerequisites
1212

1313
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.
1414

15-
.. tabs::
15+
.. tab-set::
1616

17-
.. tab:: Ubuntu
17+
.. tab-item:: Ubuntu
1818

1919
Run in a terminal:
2020

@@ -31,7 +31,7 @@ If you downloaded and installed SOFA and its headers from the `SOFA website <htt
3131
sudo apt install libopengl0
3232
3333
34-
.. tab:: MacOS
34+
.. tab-item:: MacOS
3535

3636
Run in a terminal:
3737

@@ -54,7 +54,7 @@ If you downloaded and installed SOFA and its headers from the `SOFA website <htt
5454
pip3 install numpy
5555
5656
57-
.. tab:: Windows
57+
.. tab-item:: Windows
5858

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

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

100100

101-
.. tabs::
101+
.. tab-set::
102102

103-
.. tab:: Ubuntu
103+
.. tab-item:: Ubuntu
104104

105105
Run in a terminal:
106106

@@ -109,7 +109,7 @@ Before running your simulations, you must make sure to define the following envi
109109
export SOFA_ROOT=/path/to/SOFA_install
110110
export PYTHONPATH=/path/to/SofaPython3/lib/python3/site-packages:$PYTHONPATH
111111
112-
.. tab:: MacOS
112+
.. tab-item:: MacOS
113113

114114
Run in a terminal:
115115

@@ -120,7 +120,7 @@ Before running your simulations, you must make sure to define the following envi
120120
export PATH="/usr/local/opt/python@3.10/bin/:$PATH"
121121
122122
123-
.. tab:: Windows
123+
.. tab-item:: Windows
124124

125125
* Create a system variable **SOFA_ROOT** and set it to ``<SOFA-install-directory>``
126126
* Create a system variable **PYTHON_ROOT** and set it to ``<Python3-install-directory>``

docs/sphinx/source/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ sphinxcontrib-contentui
33
readthedocs-sphinx-search
44
sphinx-autodoc-typehints
55
sphinx-rtd-theme
6-
sphinx-tabs
6+
sphinx-design
77
sphinx-autosummary-autocollect

0 commit comments

Comments
 (0)